README.md

Core

The core API server & authentication system.

Development Setup

Just run:

$ ./bin/setup

You may want to change the app's default environment variables, which lays in .env.

Deploy

This application is designed under The Twelve-Factor App pattern, making its deployment and operations on cloud platforms easy.

It's also aimed to be Heroku deployable:

Management

Visit http(s)://url_of_your_app/admin to access the control panel. The default account and password is admin / password. Please change it immediately after your first login by clicking your administration account name ("admin") located at the top-right corner.

You can also type bin/console Enter in the terminal to enter the rails console.

Feel free to check out the wiki for further information.

Testing

Run the following command to execute all test suites:

$ bundle exec rake

For CI or continuous deployment servers, use the bin/test command to automatically retry the entire test suite on failure for up to 3 times.

Chat

License

Copyright (c) 2015 MISK. Licensed under GNU AGPL-3.0 with the following conditions:

This software can only be used to power a service where end users are not (able to be) charged for. An additional license should be made if this condition is not obeyed.

Contributing

1. Fork it.
2. Create your feature branch (git checkout -b my-new-feature).
3. Commit your changes (git commit -m 'add some feature').
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request.