Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 1.49 KB

README.md

File metadata and controls

37 lines (23 loc) · 1.49 KB
Raw

Codeship Status for databraid-dashboard/transit-api

Databraid Transit API

Description

An API that uses Express to give realtime public transit directions from a starting point to a destination and public transit alerts for the San Francisco Bay Area. This API uses the Google Directions API to retrieve multiple routes and travel information between an origin and a destination for respective routes by public transit. This API uses uses the 511.org API to retrieve alerts information for the bay area and parse the alerts for information on which bus lines are affected.

Usage

Usage

Before beginning:

  1. Make a .env file containing a Google Maps API key for the GOOGLE_MAPS_API_KEY variable and a 511.org API key for the FIVE_ONE_ONE_API_KEY variable. Also set what port the API is running on with the PORT variable. A Google Maps API key can be requested from Google here. A 511.org API key can be requested here.
  2. Make sure you have Docker installed and running, then run the following commands from termnial:
npm i
npm run up

When finished developing do:

npm run down

Testing and linting can all be done respectively with:

npm test
npm run lint

It looks like we made a change