evandbrown / commute-planner

Commuter management & planning tool.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Commute Planner Build Status Code Climate Dependency Status

Installation

Clone to your local directory to begin.

$ git clone git@github.com:conveyal/commute-planner.git
$ cd commute-planner

Environment Variables & Config

All environment variables needed can be found in .env.tmp and environment specific URLS can be found in config.json.tmp. Copy the .tmp files to non-temp versions and configure accordingly. Environment variables can also be set machine wide for deployment.

MongoDB

Install locally or use a service like MongoLab. Set MONGODB_URL accordingly.

OpenTripPlanner

The planner requires an instance of OpenTripPlanner running with the GTFS feeds you would like to analyze. Manage your OTP endpoint in config.json.

Component

Commute Planner uses Component to manage client side dependencies and building. Running make installs the necesary node modules, downloads the components, and builds the client side JavaScript and CSS.

When NODE_ENV is set to development the server will rebuild the client side dependencies on each change.

Running

npm start

Runs node bin/server. Environment variables must be set.

make serve

Runs the server as a daemon with automatic restarts by nodemon. Outputs logs to /var/tmp/commute-planner-server.log. Stores the pid in server.pid

make stop

Kills the server and cleans up the .pid.

Pushing to S3

Configure s3cmd and run make release, it will build using production and sync the build directory with your S3 Bucket.

About

Commuter management & planning tool.

License:MIT License


Languages

Language:JavaScript 95.4%Language:CSS 4.6%