docs: improved documentation

Author: mvegter

docs/CONFIGURATION.md

@@ -0,0 +1,10 @@
+# Configuration
+
+## Database
+| Variable name | Description | Default value |
+|---------------|-------------|---------------|
+| DATABASE_HOST | The host of the relational database. | localhost |
+| DATABASE_PORT | The port of the relational database. | 3306 |
+| DATABASE_USERNAME | The username which is used to authenticate against the database. | cern |
+| DATABASE_PASSWORD | The password which is used to authenticate against the database. | cern |
+| DATABASE_NAME | The name of the database | bookkeeping |

docs/CONTRIBUTING.md

@@ -0,0 +1,50 @@
+# Contributing to AliceO2 Bookkeeping
+We would love for you to contribute to *AliceO2 Bookkeeping* and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow:
+- [Coding conventions](#coding-conventions)
+- [Endpoint conventions](#endpoint-conventions)
+- [Commit Message Guidelines](#commit-message-guidelines)
+
+## Coding conventions
+To ensure consistency throughout the source code, keep these rules in mind as you are working:
+- All features or bug fixes must be tested by one or more specs (unit-tests).
+- All endpoints must be tested by one or more specs (e2e-tests).
+- All code must be formatted. An automated formatter is available (`npm run lint:fix`).
+
+## Endpoint conventions
+A **resource can be a singleton or a collection**. For example, "`customers`" is a collection resource and "`customer`" is a singleton resource (in a banking domain). We can identify "`customers`" collection resource using the URI "`customers`". We can identify a single "`customer`" resource using the URI "`/customers/{customerId}`".
+
+A **resource may contain sub-collection resources** also. For example, sub-collection resource "`accounts`" of a particular "`customer`" can be identified using the URI "`/customers/{customerId}/accounts`" (in a banking domain). Similarly, a singleton resource "`account`" inside the sub-collection resource "`accounts"` can be identified as follows: "`/customers/{customerId}/accounts/{accountId}`".
+
+### Example
+```
+GET   /orders          <---> orders
+POST  /orders          <---> orders.push(data)
+GET   /orders/1        <---> orders[1]
+PUT   /orders/1        <---> orders[1] = data
+PATCH /orders/1        <---> orders[1] = { ...orders[1], ...data }
+GET   /orders/1/lines  <---> orders[1].lines
+POST  /orders/1/lines  <---> orders[1].lines.push(data)
+```
+
+## Commit Message Guidelines
+We have very precise rules over how our git commit messages can be formatted. This leads to **more readable messages** that are easy to follow when looking through the **project history**. But also, we use the git commit messages to **generate the change log**.
+
+### Format
+Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a type, a scope and a subject:
+```
+<type>[(optional scope)]: <description>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+### Examples
+```
+docs(changelog): update changelog to beta.5
+```
+```
+fix(release): need to depend on latest rxjs and zone.js
+
+The version in our package.json gets copied to the one we publish, and users need the latest of these.
+```

docs/DEVELOPMENT.md

@@ -32,9 +32,6 @@ $ npm run sequelize -- seed:generate --name <MIGRATION NAME>
 $ npm run sequelize -- db:seed:all
 ```
 
-## Commit naming convention
-We use the [`Conventional Commits`](https://www.conventionalcommits.org/en/v1.0.0/) format, which is a specification for adding human and machine readable meaning to commit messages.
-
 ## Versioning
 
 example: ```R.Arsenic.sp1.v0.0.1```

lib/config/database.js

@@ -13,6 +13,7 @@
 
 // Default configuration
 let host = 'localhost';
+let port = 3306;
 let username = 'cern';
 let password = 'cern';
 let database = 'bookkeeping';
@@ -21,6 +22,10 @@ if (process.env.DATABASE_HOST) {
     host = process.env.DATABASE_HOST;
 }
 
+if (process.env.DATABASE_PORT) {
+    port = process.env.DATABASE_PORT;
+}
+
 if (process.env.DATABASE_USERNAME) {
     username = process.env.DATABASE_USERNAME;
 }
@@ -40,6 +45,7 @@ if (process.env.NODE_ENV === 'test') {
 module.exports = {
     dialect: 'mariadb',
     host,
+    port,
     username,
     password,
     database,

lib/database/index.js

@@ -36,6 +36,7 @@ class SequelizeDatabase extends IDatabase {
 
         this.sequelize = new Sequelize(Config.database, Config.username, Config.password, {
             host: Config.host,
+            port: Config.port,
             dialect: Config.dialect,
             dialectOptions: {
                 charset: 'utf8mb4',