Skip to content

bus-detective/web-client

Repository files navigation

Codeship Build Status Code Climate

Bus Detective - Web Client

Bus Detective allows you to see real-time data for the Cincinnati Metro busses.

Prerequisites

You will need the following things properly installed on your computer.

Installation

  • git clone <repository-url> this repository
  • change into the new directory
  • npm install
  • bower install
  • cp .env.example .env ** Modify the .env to match your environment *** API_HOST should point to localhost for development *** REDIS_* Should point to youre local config

Running / Development

  • ember server
  • Visit your app at http://localhost:4200.
  • You'll probably need to be running the server and redis. See the bus-detective app and use foreman start -f Procfile.dev

Code Generators

Make use of the many generators for code, try ember help generate for more details

Running Tests

  • ember test
  • ember test --server

Building

  • ember build (development)
  • ember build --environment production (production)

Deploying

ember-cli-deploy is used to deploy assets to S3 and manage revisions of built index.html files (served through Redis). Make sure environment variables are set in .env.deploy.production for S3 and Redis.

ember deploy --environment=production (--activate=true)

The deploy command does the following:

  1. Builds and fingerprints assets
  2. Uploads built assets to S3
  3. Pushes a version of index.html to the Redis instance running on Heroku
  4. If used with the option --activate=true, automatically activate the current revision

To update the current revision of index.html served from the rails IndexController

ember deploy:list --environment=production

This will list each revision of index.html stored in Redis. To deploy a revision, run:

ember deploy:activate <revision-key> --environment=production

Further Reading / Useful Links

License

This project rocks and uses (MIT-LICENSE).

Contributing

GitHub's guide for Contributing to Open Source offer's the best advice.

tl;dr

  1. Fork it!
  2. Create your feature branch: git checkout -b cool-new-feature
  3. Commit your changes: git commit -am 'Added a cool feature'
  4. Push to the branch: git push origin cool-new-feature
  5. Create new Pull Request.