reduncan / yelpclone

This is a project for a Coding Bootcamp. We are not profiting from this project.
https://yelpper.herokuapp.com/
3 stars 4 forks source link

yelpclone

This is a project for a Coding Bootcamp. We are not profiting from this project.

yelp is a web app that allows users to search for businesses and restaurants anywhere in the USA. Each business page shows the hours of operation, price rating, menus, reviews, user ratings and many more aspects of their business.

For this project we were tasked with duplicating the yelp web app and having the following features:

Getting Started

To get started with this project you will need to clone into the repository on your machine. Once you have cloned the repository you will need to run npm install to install all of the needed packages to run the app. After you have installed the needed packages you can start a local server by running npm start in your terminal. Now you are ready run our app locally.

Prerequisites

You will need the following isntalled on your machine to be able to run our app:

Our project uses dotenv node package.

You need to create an .env file with GEOCODE_KEY={YOUR-API-KEY} as an environmental variables for the results to render.

Deployment

We have our app set to run on port 3000. If you prefer to use a different port feel free to change the port after cloning into the repository.

Contributing

We are currently accepting contributions to this project. Feel free to open any custom issues or bugs.

Authors

License

This project is licensed under the MIT License

Acknowledgments