Meal Map

Meal Map

Meal Map is a web application that allows users to discover and explore various restaurants and their menus. Users can search for restaurants based on location, cuisine, and other filters. The application also provides information about each restaurant, including ratings, reviews, and contact details. With Meal Map, users can easily find their next delicious meal!
Explore the docs »

View Demo · Report Bug · Request Feature

About The Project

(back to top)

This project was built using the following technologies:

• MongoDB - Database used for storing restaurant and user data
• Express.js - Web application framework used for building the backend server
• React.js - JavaScript library used for building the frontend user interface
• Node.js - JavaScript runtime environment used for running the server-side application
• GraphQL - Query language and runtime used for APIs
• Tailwind CSS - Utility-first CSS framework for styling
• ESLint - JavaScript linter for identifying and reporting code errors and style issues
• Prettier - Opinionated code formatter to ensure consistent code style across the project
• Bootstrap - Frontend framework for responsive web design
• Stripe - Payment processing API for handling transactions
• Google APIs - Google's suite of APIs for maps, geolocation, and more
• Flowbite React - UI component library based on Tailwind CSS for React applications

Getting Started

Follow the provided instructions below to clone the repo then start the application. Enjoy!

Prerequisites

Please download the latest version of node.js via the following

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/Jason897571/Meal-Map.git

2. Install NPM packages

   npm run install

3. Create .env file in root directory and add the following:

   MONGODB_URI = Grab a MongoDB URI from MongoDB Atlas by making an account. Refer to below
   GOOGLE_API_KEY = Get an API key from Google Developer. Refer to below

   • Mongo Atlas Guide
   • Google API Guide

4. Run the following command in the root directory

   npm run dev

(back to top)

Contributing

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!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License.

(back to top)

Members!

Jason

Github: (https://github.com/Jason897571)

Bahman

Github: (https://github.com/bahman927)

Garret

Github: (https://github.com/garrethil)

Sajjad

Github: (https://github.com/Sajjadalgburi)

(back to top)