MenuMap is a web application project that uses restaurant/dish🍔 curation and maps🗺️ to empower people who may have felt restricted in their diets to expand and experience foreign cuisines and support businesses near them📈.
MenuMap caters to a diverse user base, from students👩🏻🎓 on a budget to adventurous eaters looking for a great recommendation. The app will take inputs🔤 from the user such as desired price range, type of cuisine and dietary restrictions to filter nearby restaurants and display the choices on an interactive map📍.
Link to website not available (ran out of credits)
To setup the project locally, follow the instructions below-
- npm
if not already installed, refer to the installation guide🔗
after installation, run the following command to validate-npm --version
-
Clone the repository using the following command-
git clone git@github.com:jonahkimm/MenuMap.git
-
Install required packages
npm install
-
Run the Application
npm start
HTML is the backbone of the web, providing a standardized markup language understood by all browsers. Its structured approach enhances accessibility, SEO, and content readability. We have used it to construct the body of our application.
Tailwind CSS utilizes a utility-first methodology, allowing for rapid development by applying small, single-purpose classes directly in the HTML. This approach speeds up the styling process and encourages consistency.
React.js follows a component-based architecture, allowing developers to build UIs by breaking them down into reusable components. This modularity enhances code reusability, maintainability, and scalability. Collectively, we are most familiar with React. It is also an industry staple thus, has a lot of support in the open-source market as well.
Jest is known for its simplicity and ease of adoption. It comes with an intuitive API that allows developers to write tests quickly and efficiently. Jest supports different types of tests, including unit, integration, and end-to-end tests. Its versatility allows for comprehensive test coverage across the application stack. It was also suggested to us by our instructor taking into account our overall tech stack and hence, we decided to use it.
GitHub Actions automates various workflows, including continuous integration and deployment. It allows you to build, test, and deploy code automatically, streamlining the development pipeline. As GitHub's native CI/CD solution, GitHub Actions seamlessly integrates with repositories and pull requests.
Netlify simplifies the deployment process by providing an intuitive interface where developers can easily deploy static sites or applications directly from their Git repositories. Continuous deployment is automated, triggered by repository updates. Moreover, we decided to use it since it's free.
- Filtering
preset options to filter on the basis of dietary restrictions, allergies, health stats and display recommendations
- Dish Recommendations
this feature is especially curated for adventurous eaters ;)
- Dish Explanations
displays a short summary of what the dish is and some health stats
- Nearby Restaurants
pins nearby restaurants on a map with a brief summary of what they offer
- Restaurant Info
provides a link to restaurant website, their contact number & many more :)
- Filtering Based on Location displays nearby restaurants on the basis of location input.
Distributed under the MIT License. See LICENSE for more information.
-
AI Declaration Forms
Milestone1
- Jonah Kim
- Aarham Haider
- Jeet Patel
- Aryaman BahugunaMilestone2
- Jonah Kim
- Aarham Haider
- Jeet Patel
- Aryaman Bahuguna -
Resources
Documentation
Youtube