Skip to content

README.md

Latest commit

 

History

History
50 lines (37 loc) · 1.57 KB

README.md

File metadata and controls

50 lines (37 loc) · 1.57 KB

schedules

Beautiful class registration webapp for universities. Head over to our wiki for information on contributing.

Required tools

  • NPM - Node.js package manager; should be installed when you install node.js.
  • Bower - Web package manager. Installing Bower is simple when you have npm:
$ npm install -g bower
  • Gulp - Download and Install Gulp.
$ npm install -g gulp
  • SASS - SASS is a CSS extension language used for styling Schedules frontend. You'll need the latest version of the SASS Ruby gem in order to build the stylesheets.
$ sudo gem install sass

Getting started

To build and run the app locally run the following commands:

  1. Install development dependencies with npm install
  2. Install app dependencies with bower install
  3. Run with gulp watch

You can then view the app at http://localhost:9000/

Contributing

  1. Fork the repo
  2. Create a new branch with either a feat/ or fix/ prefix
  3. Commit and push changes to your repo
  4. Create a new Pull Request

We will accept pulls that:

  • Don't break anything
  • Are well documented and commented
  • Are written in pure JavaScript (sorry no Coffeescript)
  • Don't add unnecessary dependencies (no jQuery or Bootstrap please) - make use of only Angular.js, Lodash, Concise.css, and Bourbon libraries for the frontend

Contributors

Timothy Kendall, Ian Jackson, James Steininger, Ross Clare

License

The AGPL v3 License