Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cityofdetroit/ddot-info
Find schedules and real-time data for DDOT buses
https://github.com/cityofdetroit/ddot-info
Last synced: 6 days ago
JSON representation
Find schedules and real-time data for DDOT buses
- Host: GitHub
- URL: https://github.com/cityofdetroit/ddot-info
- Owner: CityOfDetroit
- License: 0bsd
- Created: 2017-11-02T12:52:25.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-02-23T21:55:48.000Z (9 months ago)
- Last Synced: 2024-04-14T07:56:38.033Z (7 months ago)
- Language: JavaScript
- Homepage: https://ddot.info
- Size: 18.1 MB
- Stars: 8
- Watchers: 12
- Forks: 4
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- License: LICENSE
Awesome Lists containing this project
README
# ddot-info
A web app for accessing DDOT bus schedules and real-time data.
This site is built on [Gatsby](https://www.gatsbyjs.com/), pointed at GTFS data stored in Postgres.
You will also need a [Netlify](https://www.netlify.com) account to deploy to production: this project uses Netlify's serverless functions. If you're developing, you can use the Netlify CLI.
## Key features
- bookmarkable route and stop pages
- time aware ui that defaults to show today's service and current trips
- live departure, scheduled departure, and ~~nearby transfer info~~ for every DDOT bus stop
- ~~location aware component to see routes and stops within a 5 minute walk of your current location~~
- digital schedule tables
## Data sources
- [DDOT GTFS](https://data.detroitmi.gov/datasets/ddot-gtfs-file)
- [Clever Devices API](https://myddotbus.com)
# Development
## Installation
`yarn` will install the basic project dependencies.
You'll also want to install `gatsby-cli` and `netlify-cli`.
## Setting up the database
We recommend installing Postgres 12 along with the latest PostGIS extension that works with your version of Postgres.
We use [gtfs-sql-importer](https://github.com/fitnr/gtfs-sql-importer) to import GTFS files into a database.
The database structure is based on the one from **gtfs-sql-importer**, but we add a few helper SQL functions (defined in functions.sql) which make new fields and relationships in the GraphQL server, provided by [gatsby-source-pg](https://www.gatsbyjs.com/plugins/gatsby-source-pg/).
You can create a database (here, named `transit`) and import the project database structure from the command line.
```bash
createdb transit
psql -d transit -c 'CREATE EXTENSION postgis;'
psql -d transit < ./gtfs.sql
```
Next, grab the latest version of DDOT's GTFS data and import it to this database using `make` from the **gtfs-sql-importer**:
```bash
curl -o ddot_gtfs.zip "https://detroitmi.gov/Portals/0/docs/deptoftransportation/pdfs/ddot_gtfs.zip"
export PGDATABASE=transit && make load GTFS=ddot_gtfs.zip
```
You should see the output from SQL insert commands. Importing the DDOT GTFS file typically takes about 2-3 minutes on a newer machine.
### Configuration
Create a `.env.development` file from the given `.env.example` file, filling in your database details and the `DDOT_KEY` API key, which can be self-provisioned at [myddotbus.com](http://www.myddotbus.com/).
### Running the development server
You should be able to run the development server with the `netlify dev` command.
This will run a local Functions server that mirrors how the serverless functions operate in production.
In order to deploy this site to production, you would need a Netlify account.