Start this project with Single Command
View Demo Β· Report Bug Β· Request Feature
Monstar Lab Bangladesh have a team party every month, every team goes out and has lunch together to strengthen team bonding. Through this application, they can easily search restaurents nearby (within 3 km).
(ππ»)
-
Random selection of a restaurant within 3 km of the Monstar Lab Bangladesh Office.
-
Provide a map view showing the location of the restaurant
-
Do a keyword search for restaurants within 3 km of the office.
-
Instead of showing all restaurents at a time, we have CLUSTER support.
-
PWA support.
(ππ»)
- React.js
- TypeScript
- Redux Toolkit
- Ant Design
- Google Map
- FOURSQUARE Places API
- Tailwindcss
- React Hook Form
- React Query
- Supercluster
- Use Supercluster
(ππ»)
Instructions to setup this project locally. To get a local copy up and running follow these simple example steps.
- Node.js
- Yarn
npm install --global yarn
- Git
- Visual Studio Code
- Clone the repo
git clone https://github.com/alamariful1727/restaurant-finder.git
- Install packages
yarn
- Create a project at FOURSQUARE and get your keys (Client Id & Client Secret) from https://developer.foursquare.com
- Copy
.env.example
and create a new file namedenv.local
REACT_APP_FSQ_CLIENT_ID=<ENTER FOURSQUARE CLIENT_ID> REACT_APP_FSQ_CLIENT_SECRET=<ENTER FOURSQUARE CLIENT_SECRET> REACT_APP_FSQ_VERSION=20190425 REACT_APP_GOOGLE_API_KEY=<ENTER GOOGLE MAP API KEY>
(ππ»)
- Run the project locally
yarn start
- Watch CSS
yarn watch:css
(ππ»)
- Run tests
yarn test
(ππ»)
- Build minified CSS
yarn build:css
- Run build command
yarn build
(ππ»)
Static type checking, better intelliSense, better refactoring, Less amount of undefined errors & Better readability and maintainability.
For efficient Redux development.
Optimized for production with minified and purged css.
A production-ready service worker for your Progressive Web App.
Two types of restrictions have been applied to the credential.
- Application restrictions
- Website restrictions
- API restrictions
- Restrict key
- Maps JavaScript API
- Restrict key
@react-google-maps/api
package has been used for Google Map rendering.
Instead of showing all restaurents at a time, we have used CLUSTER.
supercluster
& use-supercluster
packages
have been used for clustering.
(ππ»)
-
Search nearby venus by using user's current location
-
Search nearby venus by using user's custom location input
-
Add more information in single venue view
-
Add splash screens for PWA
-
Add MIT License
(ππ»)
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
(ππ»)
Ariful Alam
(ππ»)