Skip to content

Latest commit

 

History

History
121 lines (83 loc) · 6.03 KB

README.md

File metadata and controls

121 lines (83 loc) · 6.03 KB

GitHub license PRs Welcome codebeat badge CodeFactor Codacy Badge Lighthouse Badge GTMetrix Badge

🔎 Overview

Nearby Locations is a public service to explore your current nearby places as fast as possible. Even more, find your nearby locations details. Created with React with awesome components.

This app looks like this:

Screenshots may change in the future because of UI/UX changes.

🖥️ Desktop view:

📱 Mobile view:

Homepage Locations Details

🚀 Usage

Run this commands in respectively in your terminal.

 git clone https://github.com/mohammadnedaei/Nearby-Locations-React.git
 cd Nearby-Locations-React
 npm i

Change .env properties depending in your information and then go to the next step.

 npm start

npm start Runs the app in the development mode. Open http://localhost:3000 to view it in your browser. The page will reload when you make changes. You may also see any lint errors in the console.

🧰 Libraries and Tools

✅ Responsive Design & Mobile Friendly
✅ PWA (5/7)
✅ Lighthouse

  • Performance (%99)
  • Lighthouse Accessibility (%100)
  • Lighthouse Best Practices (%92)
  • Lighthouse SEO (%100)

✅ Heroicons
✅ Tailwind UI
✅ Material UI

  • Material icons

✅ Axios
✅ React Router
✅ React Hooks
✅ jQuery
✅ React Responsive Carousel
✅ React Gradient Text (rgt)
✅ Github Pages
✅ Foursquare API

🔧 Contributing

Feel free to fork this repo and make pull requests. You can learn more about React here

🎯 TODO

🚧 Code factor & code quality tools improvements
🔃 Add Shortcuts in manifest
🚧 Include rating API (use in locations page and details)
🚧 Fix desktop Chrome and Opera geolocation bug
🚧 Add a Loader for locations list
🔃 StoryBook
🔃 Add install button in settings for PWA desktop
🔃 Service Worker for push notifications
🔃 Service Worker for Cache
🔃 Service Worker for fetch

💚 Support

Sociabuzz

✍🏻 Author

 Mohammad Nedaei

📞 Contact

Discord: Mohammad81#3277

Linkedin

©️ License

Nearby Locations is MIT licensed.