Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 3.05 KB

README.md

File metadata and controls

62 lines (41 loc) · 3.05 KB
Raw

Bus Watch

By Steve Zaske, Lynn Pangelinan, Joe Kramer, and Witty Chang

This application estimates bus arrival times to the bus stops in Downtown Seattle.

Setup

  1. git clone https://github.com/Epicodus-SZ/bus-watch
  2. Run npm install
  3. Run bower install
  4. Navigate to /Users/Guest/Desktop/bus-watch/src/app and create new file called api-keys.ts
  5. Create a Firebase account if you do not already have one and navigate to your Firebase Console and create a new project
  6. API keys are stored in a file called /src/app/api-keys.ts. Refer to example-api-keys.ts in the root folder to see how you can reproduce this file. The application will NOT work without this file

Development server

Run ng serve --open for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the -prod flag for a production build.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor. Before running the tests make sure you are serving the app via ng serve.

Prerequisites

You will need the following items properly installed on your device.

  • Node.js (with NPM)
  • TypeScript
  • Bower
  • Web browser software application of your choice (e.g. Google Chrome, Mozilla Firefox, etc.)

Technologies Used

  • Angular CLI
  • Bower
  • Firebase cloud service
  • Google Chrome
  • Node Package Manager
  • One Bus Away API
  • TypeScript

Support and Contact Details

Please feel free to contact [email protected] if you have any questions, issues, concerns, comments or suggestions.

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Copyright (c) 2017 Steve Zaske, Lynn Pangelinan, Joe Kramer, and Witty Chang