kolledata

1. Install node

Preferably from the official site.

2. Install a MySQL server

The original MySQL and MariaDB have been tested and work fine without any differences in the following steps. MariaDB is a clear recommendation because of severe awesomness.

3. Clone the repo

$ git clone https://github.com/kollemate/kolledata.git && cd kolledata

4. Install dependencies

If you don't have Bower installed you might need to run sudo npm install -g bower first.

$ npm install
$ bower install

5. Create MySQL config

$ cp ./config/example_mysqlconfig.js ./config/mysqlconfig.js

edit ./config/mysqlconfig.js to match your settings

exports.config = {
    host: "host",
    // port: "port",
    user: "user",
    password: "password",
    database: "kolledata"
};

The port line can be uncommented if your MySQL port is not the standard 3306.

6. Start your MySQL server

If your linux distribution uses systemd, use one of the following commands if you want to start the MySQL server at boot.

$ sudo systemctl restart mysqld.service
$ sudo systemctl enable mysqld.service

Or... you know, just start your MAMP, XAMPP or whatever right now.

7. Setup the kolledata database

$ mysql -u USERNAME -p -h HOST < database/scripts/setup.sql

You might want to add some example data as well:

$ mysql -u USERNAME -p -h HOST < database/scripts/insertExampleData.sql

8. Start the server

node app.js

The server can now be viewed at localhost:8080 at the default port. This can be passed in as an environment variable if you want a different port.

Troubleshooting

Make sure you've installed all the dependencies with bower and npm (step 4).

Is your MySQL server running and are the correct details in your mysqlconfig.js (step 5)?

Something entirely different? Please write an issue :)