• Docker
• yarn (to provide simple command aliases for lengthy docker commands)

Run yarn build to build and yarn start at the command line to run the API locally. Be sure you have the Docker agent running.

You'll also need to create the database tables the application depends on and seed them with data yarn db:reset.

Finally, make an API request to see if your environment is configured correctly. See the documentation if you're looking for a sample request.

The API is currently backed by a PostgreSQL database with the PostGIS extension.

Most of our data comes from Open Data SF. See db/seeds.rb and Dockerfile.db for further details. The specific Sf 311 case data comes from https://data.sfgov.org/City-Infrastructure/311-Cases/vw6y-z8j6.

You can connect to the local Postgres instance by running yarn db at the command line.

Our production DB is currently hosted on AWS (RDS). Use the following command to connect to it:

PGPASSWORD=<<PASSWORD>> psql bikelane bikelanes --host bikelanes.cl6adk7d8ywn.us-east-1.rds.amazonaws.com

Check your Heroku account to retrieve the password or talk to a maintainer.

The app lives on Heroku at https://lane-breach.herokuapp.com/. Any pushes to the heroku branch will get automatically deployed, including migrations.

To push what's on master onto the heroku branch, you can run git push origin master:heroku.

We welcome contributions! All of our contributors are expected to follow the rules outlined in our Code of Conduct. Please create a separate pull request against master for each new feature/bug-fix. We will try to use Github issues whenever possible to describe tasks that we need to do.

Steps for building the various apps, and an overview of the design can be found on the wiki. We're excited to see your PRs!