Skip to content
This repository has been archived by the owner on Sep 28, 2018. It is now read-only.

Latest commit

 

History

History
73 lines (48 loc) · 2.45 KB

README.md

File metadata and controls

73 lines (48 loc) · 2.45 KB

Icarus

Build Status

Web browser client for the Icarus project of the Pitt Computer Science Club

Prerequisites

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

Programs

Projects

Installation

  1. If you're contributing, fork the repo

  2. Create a new Firebase server and set an environment variable to the URL like so:

    export ICARUS_FIREBASE_URL='https://some-project.firebaseio.com/'
  3. git clone <repository-url> the repository

  4. change into the new directory

  5. npm install

  6. bower install

Contributing

We would love to have your help with the project! If you have ideas for new features, feel free to make an issue here on Github so we can plan things out, and then fork the repo and get to work! Pull requests with updates and fixes are welcome as well!

Some notes about pull requests: please follow our styleguide for information about the code style of the project and what our expectations are. Contributed code will also not be accepted without tests!

Ember Commands to Know

  • ember server
  • ember test
    • Runs the test suite in the terminal through Phantom.js
    • Can be run in the browser using ember test --serve
  • ember generate __type__ __name__
    • Generate new files in the project
    • Always use the generators, don't make new files by hand!

Configuration

Mixpanel Tracking

If you want Mixpanel tracking to work in development, just set an environment variable of ICARUS_MIXPANEL_TOKEN like so:

export ICARUS_MIXPANEL_TOKEN=__some_mixpanel_token__

If the token is not present, tracking will just be ignored.

Further Reading / Useful Links