tobyds / spot

Spot

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

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. License
5. Contact
6. Acknowledgments

About The Project

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.

(back to top)

Built With

(back to top)

Getting Started

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

Prerequisites

• npm - (Link)

  npm install npm@latest -g

• Obtain API Keys for

  • Google Places API
  • Mapbox
  • Any of the OAuth Services you wish to test:
    • Google
    • Facebook
    • Apple

• Create a postgres database

Installation

1. Clone the repo

   git clone https://github.com/london-codeworks-thesis/spot.git

2. Create your own .env file and insert API Keys, and database connection URI:

   cp .env.local.template .env.local

3. Install NPM packages

   npm install

4. Create database tables

   npm run migrate:dev

5. Seed database

   npm run db:seed

6. Start the app

   npm run dev

7. Access the app at http://localhost:3000

(back to top)

Contributing

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!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Toby Dixon Smith - [email protected] Jason Wong - [email protected] Sam Polge - [email protected] Sunny Anter - [email protected]

Project Link: https://github.com/london-codeworks-thesis/spot

(back to top)

Acknowledgments

• Github Readme Template

(back to top)