newlinedotco / yelp-clone

Yelp clone for blog post at fullstackreact.com
https://www.fullstackreact.com/articles/react-tutorial-cloning-yelp/
37 stars 15 forks source link

Yelp clone

TLDR: demo

This repository is the main repo for the app discussed and built in great detail at the fullstackreact /blog. For an in-depth discussion, check out the post.

Getting yelp up and running

Getting the app up and running is straight-forward. Clone the repo, install the dependencies, and run the start script.

Cloning the repo:

$ git clone https://github.com/fullstackio/yelp-clone.git yelp
$ cd yelp

Install the dependencies

$ npm install

Configuring the application

This app uses dotenv for configuration. In order to configure the application for your own api access, grab an api token from google at https://developers.google.com/maps/documentation/javascript/ and set it in a file called .env at the root for a key called __GAPI_KEY__. For instance, say that your gapi key is: abc123. Your .env file should look like:

GAPI_KEY=abc123

You can also create this file by copying the .env.example file at the root:

$ cp .env.example .env

Starting the application

$ npm start

This app uses the following technologies:

Running the tests

The application is built using tests, including the fantastic enzyme and chai libraries. To run the tests, use the npm test script:

npm run test

Check out the blog post for more information on how this app was built and a complete tutorial on using React to build your own apps.

Contributing

git clone https://github.com/fullstackio/yelp-clone.git yelp
cd yelp
npm install
npm start

fullstackreact.com