A RESTful web API that allows users to buy and sell home-cooked food items with their local neighbours. Core features are built around the Google Maps API and includes an interactive map browsing interface, dynamic search, sorting, filtering.
Final project for Lighthouse Labs.
Created by Albert Ho,
Ben Catton,
and Christian Girling.
Check out our planning documents in the wiki tab!
Clone the project from githup using either HTTPS or SSH
- HTTPS -
git clone https://github.com/bkcatton/NeighbourEats.git
- SSH -
git clone git@github.com:bkcatton/NeighbourEats.git
-
You will need your own google maps api key. Sign up for a free one here
You must enable the following options from the google maps api dashboard:
i. Distance Matrix API
ii. Geocoding API
iii. Maps JavaScript API
-
You will need your own Stripe API key. Sign up for one here
-
Assign both of the API keys to your own
.env
file in the /client directory. See the.env.example
file for reference -
You may need to download an extension to allow CORS on your browser. We used this extension from the chrome web store.
- Ensure you have PostgreSQL installed on your local machine.
- Create a database on your local machine and put the appropriate keys to the
.env
file in the /server directory. See the.env.example
file for reference.
To install server dependencies:
- Navigate to /server with
cd server
- Install dependencies with
npm install
To install client dependencies:
- Navigate to /client with
cd client
- Install dependencies with
npm install
- Open two different terminal windows, one for the server and one for the client
- Navigate to /server with
cd server
- Seed database with the following command:
npm run db:reset
- Start the server with
nodemon index.js
, ornode index.js
- In your other terminal window, navigate to /client with
cd client
- Start the client side with the following command:
npm start
Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.
The page will reload when you make changes.
You may see some lint errors in the console.