/strider

Primary LanguageCSSGNU Affero General Public License v3.0AGPL-3.0

Strider [Web client]

##Running locally You'll need npm and grunt for this to work.

First install dependencies:

$ npm install -g grunt-cli
$ npm install -g bower
$ npm install
$ bower install

Now just open index.html in your browser and let the magic happen!

##Deploying The whole process of compiling and deploying to the production environment is done with grunt. At the moment there are two tasks available:

  1. build Generates a build/ folder with all the necessary files to run the app. Use it to test that everything works.
  2. deploy Includes build, and once the app is built it deploys it to gh-pages. You should never push or touch gh-pages directly, it's easier and safer to use the Grunt task.

So to deploy your work:

$ grunt deploy

##Adding dependencies Use bower to add any client-side JavaScript:

$ bower install <library>

Then we need to add it to the Requirejs configuration, luckily grunt will do that automatically for us :)

$ grunt

The default task for grunt takes all the bower components and adds them to the Requirejs paths configuration, so they are available in all the modules. Now you can simply add the dependency with the bower installed name.

##Contributing Pull Requests are always welcome, take a look at the existing code to become familiar with our style guide.

##License Strider is released under the GNU Aferro GPL v3.0 License

If you want to use it for commercial purposes get in touch with us.