third_rail

README

The Third Rail API is part of the SMARTA project - a collection of tools and services built around MARTA APIs supplemented with analysis of historic patterns, static schedule data, and external sources like Twitter.

Continuous Integration Status

Project Goals

Goals? Oh we've got goals - check 'em out in the overview document.

Generating swagger docs

When making changes to API functionality and especially when changing the signature of API calls, you should update the corresponding Swagger comments as well, and then regenerate the Swagger docs.

To do this, first install the Swaggo CLI:

go get -u github.com/swaggo/swag/cmd/swag

Then run:

go generate .

TODO

• Find rail schedule by line
• Find rail schedule by station
• Find bus schedule by stop
• Find bus stop by route
• Find routes by stop
• Find rail stations by location
• Find nearest stations
• Parking status updates
• Emergency notification updates
• Add projected arrival/departure time based on historical trends

Project Maturity

SMARTA is very young. Young, scrappy, and hungry. 😎

Prerequisites

You will need a MARTA API key to fetch the live results from MARTA's base API. For Twitter interactions you will need a Twitter Developer account and an API client and secret.

To build and run Third Rail as a container you will need Docker.

Building

To build the application, run:

make

Tests

To run tests for the application, run:

make test

License

Copyright© 2020 SMARTA Transit

Distributed under the GNU Public License version 3