Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 1.61 KB

README.md

File metadata and controls

46 lines (31 loc) · 1.61 KB

commuter-backend

Build Status VSTS Build Status npm version GitHub license Logo

The typescript server for the application running on google cloud platform

Installation

We recommend you clone the repo for easiest implementation:

Clone a copy of the repo:

git clone https://github.com/hack-utd/commuter-backend.git

Change to the TypeScript directory:

cd TypeScript

Install Gulp tools and dev dependencies:

npm install -g gulp
npm install

Usage

Then in the portions where it says the certain API's please refer to Google Cloud Platform, Lyft, and Mapbox for API generation keys.

Documentation

Take a look at the documentation table of contents. This documentation is bundled with the project which makes it available for offline reading and provides a useful starting point for any documentation you want to write about your project.

License

The code is available under the MIT license.