Explore cities

This project lets you explore cities that are near you for a quick fun getaway!

Table of Contents

• About the Project
• Getting Started
• Available Scripts

About The Project

This project was created by Aarushi Pandey, Gustavo Oviedo, Jerry Teng, Michael George, and Suleman Butta during the Fall 2020 session of Codubee. We built this project as a safe way to get people out of their homes and visiting local cities. Covid has made it difficult to travel by air, so this tool explores cities within driving distance of a given zip code.

Getting Started

To get a local copy up and running follow these simple steps.

Installation

1. Clone the repo

git clone https://github.com/Codubee/ExploreCitiesTTH4-6.git

2. Install NPM packages in frontend and backend folders

cd frontend
npm install

cd backend
npm install

3. Set up API KEYS in .env file in backend folder
   WEATHER_KEY
   YELP_KEY

Available Scripts

Frontend

In the frontend directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\

Backend

In the frontend directory, you can run:

npm start

Runs on http://localhost:8080

npm test

Runs a basic test using Mocha

Your app is ready to be deployed!

See the section about deployment for more information.