-
Notifications
You must be signed in to change notification settings - Fork 0
Development guide
The Agora project was created with the Yeoman generator using the angular generator for convenience.
To add to the development of Agora, you will need the following:
- Installed Node.js
- Installed Grunt
npm install -g grunt-cli - Installed Ruby (Windows users can get it here) - for Windows users please note: Install with "Add Ruby executables to your PATH" checkbox ticked.
- Installed Bower
npm install -g bower - Installed Compass
gem install compass - Installed Karma
npm install -g karma@canary
Make sure you run the following withing the agora directory to start:
npm install
bower install
Previewing, testing and building can be done using grunt.
To preview the page:
grunt server
or to serve the built version
grunt server:dist
To test the app:
grunt test
or alternatively
karma start karma.conf.js
To build the app (Aggregate all CSS and JS file, minification etc.)
grunt build
- Indent type spaces
- Indent size 2
- Line endings: lf
- Charset: utf-8
- No trailing whitespace
- Empty line at the end of file
Commit messages should have the following a type, a scope and a subject:
<type>(<scope>): <subject>
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on github as well as in various git tools.
Must be one of the following:
- feat: A new feature
- fix: A bug fix
- docs: Documentation only changes
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- refactor: A code change that neither fixes a bug or adds a feature
- perf: A code change that improves performance
- test: Adding missing tests
- chore: Changes to the build process or auxiliary tools and libraries such as documentation generation