This project is built upon:
See our presentation here
This project has so far implemented:
And plans to implement:
After downloading the project (d'oh), you're going to need Ruby installed - This was developed using Ruby 2.x. After that, install the bundler gem, that will deal with our dependecies.
gem install bundler
After that, in the main directory, run bundle install and it install the dependecies for the project. Now, we need to setup the actual keys configuration file. For security, it is being ignored by Git and you will need to setup it manually.
cp config/key-config-example.json key-config.json
After that, change the data to match your server and API keys configuration.
Now, we have to setup the database tables. After updating your database details in key-config.json, our migration script will create the needed tables and relationships for you. Run:
ruby migrations.rb
in the main directory to get the tables setup to your database.
This project is licensed under GNU General Public License (GPL-3). The full license text is available at LICENSE.