Restaurant Finder

Fullstack PERN app that allows lists resturants and allows users to see information about that resturant as well as reviews. Users can add reviews to resturants and rate them out of 5. Users can also create, update and delete restaurants.

View Live

Table of Contents

1. About The Project
   • Built With
2. Getting Started
3. Contributing
4. License
5. Contact

About The Project

Restaurant is a full-stack web application which uses PERN (Postgres, Express js, React and Node js). The home page lists different restaurants and lists their location, price range and average ratings (based on user reviews) similar to YELP.

Users can create new restaurants, or update/delete exising ones. They also add reviews to their resturant of choice by clicking on that restaurant.

If you want to check out a live version, the frontend and backend are deployed on vercel and the database on supabase. You can check it out here: https://vercel.com/patrick-alvarezs-projects/restaurant-finder-frontend

Built With

(back to top)

Getting Started

You can check out the project live at: https://vercel.com/patrick-alvarezs-projects/restaurant-finder-frontend

If you want to use it locally you will need to:

1. Clone the repo

   git clone https://github.com/Patchalv/restaurant-finder.git

2. Install NPM packages in both the client and server folders

   npm install

3. Create .env files for the client and server directories. You can see the examples provided.
4. Create a postgresSQL database. See the visualization below aswell as instructions in server/db
5. Start server, then start client.

  npm start

(back to top)

Contributing

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!

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. See LICENSE.txt for more information.

(back to top)

Contact

Patrick Alvarez Eades - [email protected]

Project Link: https://github.com/Patchalv/restaurant-finder

(back to top)