MobistudyAPI

This is the back-end REST API of MobiStudy.

Pre requisites

You need to install the following on your system:

nodejs (v 10 or bigger)
arango DB (v 3)

Install all other dependencies with npm install.

On Arango, you must have created a dedicated database for Mobistudy, and, possibly, also a dedicated user with its password.

To start Arango, you can either install it, or use Docker. For development, use:

docker run -e ARANGO_NO_AUTH=1 -p 8529:8529 arangodb/arangodb arangod --server.endpoint tcp://0.0.0.0:8529

Run

The code is written using ES6 module, which are still experimental in nodejs. To start it:

node --experimental-modules ./src/www.mjs

You also need to provide either a configuration file with the name config.json inside the /config folder (see /config/config.template.json for an example) or provide the same configuration as environment variables.

See section about Docker for details about environmental variables.

Test

Run npm run test:unit. If you want to have the tests run continuously (as you change the code), add -- --watch.

Develop

The code is written mostly in ES6 and uses ES6 modules, please be consistent.

The folder structure is vaguely inspired by this.

project
└───config        // contains the runtime configuration files
└───models        // examples of data managed by the app, in json
└───src           // application code
│   └───DB        // access to the database
│   └───i18n      // internationalised text
│   │   └───en    // English text
│   │   └───sv    // Swedish text
│   └───routes    // API endpoints
│   └───services  // application logic
└───test          // automatic tests and experiments
    └───jest      // unit tests
    └───__tests__ // test specs

Contribute

Help is welcome! See the current roadmap of the whole project on the wiki.

If you want to add a new task, a preliminary guide is here.

Use Docker

This only explains how to build and run the Docker instance of this project. For the full setup including database and web interface, see the Wiki.

To build the docker instance:

docker build -t mobistudyapi .

Then run it with:

docker run -d \
    -p 80:8080 \
    -v /local/path/to/logs:/usr/src/app/logs \
    -v /local/path/to/config:/usr/src/app/config \
    --name mobistudyapi
    mobistudyapi

(/local/path/to/ must be substituted with the actual path).

Instead of leaving a config file on the server, for security reasons, you may also consider using environmental variables. This is the full list of variables:

Variable	Type	Default	Secret
WEB_PORT	integer	8080	NO
WEB_CLUSTER	boolean	true	NO
LOGS_FOLDER	string	'logs'	NO
LOGS_ROTATIONSIZE	string	'1M'	NO
LOGS_CONSOLE	boolean	false	NO
LOGS_LEVEL	integer	30	NO
AUTH_SECRET	string	NA	YES
AUTH_TOKEN_EXPIRES	string	'30 days'	NO
AUTH_ADMIN_EMAIL	string	NA	YES
AUTH_ADMIN_PASSWORD	string	NA	YES
DB_HOST	string	'localhost'	NO
DB_PORT	integer	8529	NO
DB_NAME	string	NA	YES
DB_USER	string	NA	YES
DB_PASSWORD	string	NA	YES
GMAIL_EMAIL	string	NA	YES
GMAIL_CLIENTID	string	NA	YES
GMAIL_PROJECTID	string	NA	YES
GMAIL_SECRET	string	NA	YES
GMAIL_REFESHTOKEN	string	NA	YES

AUTH_ADMIN_EMAIL and AUTH_ADMIN_PASSWORD are used at the first start, to generate an admin user that can be used to access the website the first time.

In a production environment, it is recommendable to use Docker secrets instead of environment variables when possible. The variables that can be passed as Docker secret are flagged in the "Secret" column.

Credits

Original idea: Dario Salvi and Carmelo Velardo.

Coordination: Dario Salvi and Carl Magnus Olsson.

Development:

License

See license file

palladog/MobistudyAPI