Skip to content

Latest commit

 

History

History
28 lines (20 loc) · 1.8 KB

README.md

File metadata and controls

28 lines (20 loc) · 1.8 KB
Raw

Pick-up

App designed to find nearby basketball courts for pick-up games. Starting off as an Austin-based project with plans for expansion to other areas as development continues.

Contribute

I'd love your help with this project. The steps below should get you going. If not, make a contribution by updating the docs!

This project makes use of several api keys, each of which is stored in a .env file that isn't pushed to GitHub for security reasons. You can register for keys by using the following links. Dark Sky API Google Places API

You will also need to make use of Firestore. Follow the directions for getting started with web to create your database for testing.

  1. Fork the project by clicking the Fork button up at the top of the screen.
  2. Clone your fork with git clone [code-you-copied-from-clone-button]
  3. cd pickup to make sure you are in the right directory
  4. Add an upstream remote for keeping your local repo up-to-date:

git remote add upstream https://github.com/chrisdesilva/pickup.git

  1. Run npm install to install project dependencies.
  2. In the root directory, create a new file called .env
  3. Copy the variables from .env.sample into your .env file and update with your keys
  4. Run npm start to start your dev environment
  5. Start contributing!

When you're ready to add your changes to the project, submit a pull request.

If you've got any ideas for making the app better, submit an issue. Thanks for helping out!