Find and rate the tastiest spots in town.
Discover hidden gems, and share with your friends!
Explore the docs »
Report Bug
·
Request Feature
Table of Contents
Spot is a social media application which allows users to discover and share their favourite restaurants with their friends. Spot shows a map of the restaurants recommended by your friends and allows you to share your own recommendations in the form of reviews.
Figma: Feel free to view the figma files for this project here
To get a local copy up and running follow these simple example steps.
-
npm - (Link)
npm install npm@latest -g
-
Obtain API Keys for
- Google Places API
- Mapbox
- Any of the OAuth Services you wish to test:
-
Create a postgres database
-
Clone the repo
git clone https://github.com/london-codeworks-thesis/spot.git
-
Create your own .env file and insert API Keys, and database connection URI:
cp .env.local.template .env.local
-
Install NPM packages
npm install
-
Create database tables
npm run migrate:dev
-
Seed database
npm run db:seed
-
Start the app
npm run dev
-
Access the app at
http://localhost:3000
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt for more information.
Toby Dixon Smith - tobydixonsmith@gmail.com Jason Wong - jasonwong_3@hotmail.com Sam Polge - sampolge1@gmail.com Sunny Anter - sunny@veskim.com
Project Link: https://github.com/london-codeworks-thesis/spot