This is the back-end REST API of MobiStudy.
You need to install the following on your system:
- nodejs (see nvmrc for version)
- arango DB (v 3.10.7)
In order to guarantee that the same version of node is used across developers, it is recommendable to use nvm and run nvm install && nvm use to switch to the node version used in this project.
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, you can use:
docker run -e ARANGO_NO_AUTH=1 -p 127.0.0.1:8529:8529 --name mobiArango arangodb/arangodb:3.10.7
to start a Docker container with Arango. You can then access the web interface on http://localhost:8529
For development, it is easier to create a configuration file, which must be named config.json and placed under the config folder. See config.template.json under the same folder as an example. You can remove the "cert" part if you don't have an https certificate and you can leave random data inside "outlook", "environmentAPIs" and "mSafety" if you don't have an account on those services. The part under "auth" configures the admin user of the server, you can specify the email address and password that you like. The "logs" part is for setting up the logging system. Inside "folder" you can user "logs", which is also included in this repository.
The part under "db" is important and is linked to how you configure Arango. Your Arango instance should have a user and a database dedicated to Mobsitudy. Once Arango is started, open the interface at http://127.0.0.1:8529, then login using the root user. If you used used ARANGO_NO_AUTH, no password should be needed.
Once inside, create a new user (you can call it “mobistudy”) and a new database (you can also call it “mobistudy”) and associate the new database to the new user. These details (database name, user name and the user password) are the same that you need to specify in the config file under “db”.
The code is written using ES6 module, so you need a recent version of NodeJS (recommended version is 16.17.0, use nvm to automatically switch among versions). To start it:
npm start
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.
You need to have a testing database running either as local install or as docker container, exposed at the port number 5555.
For example, using docker:
docker run -e ARANGO_NO_AUTH=1 -d -p 127.0.0.1:5555:8529 --name mobiTestsDB arangodb/arangodb:3.10.3
Run npm run test. If you want to have the tests run continuously (as you
change the code), run npm run test:watch.
The code is written mostly in ES6 and uses ES6 modules, please be consistent.
The folder structure follows this pattern:
project
└───config // contains the runtime configuration files
└───logs // used to store applications logs
└───models // json schema of the data managed at the API interfaces
│ └───examples // example of data
└───src // application code
│ └───DAO // access to the database
│ └───i18n // internationalised text
│ │ └───en // English text
│ │ └───sv // Swedish text
│ │ └───es // Spanish text
│ └───controllers // controllers of the API endpoints
│ └───routes // API endpoints - controllers combined
│ └───services // application logic
└───tasksuploads // stores raw data of the tasks
└───test // automatic tests and experiments
│ └───jasmine // unit tests specs
│ └───mocks // mocked objects
└───tmp // used to store data to be downloaded temporarily
Run npm run dev to start a self-restarting server. This needs nodemon package to be installed globally, do that with npm i -g nodemon.
By default, the server runs on http. In some cases you may need to use https on a local testing environment, in this case, follow this tutorial. For example, if you need the app to send data to the server through the local network, identify the IP address of the server on the local network (say it's 192.168.0.190), then run:
npm install -g mkcert
mkcert create-ca
mkcert create-cert 192.168.0.190Help 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.
Original idea: Dario Salvi and Carmelo Velardo.
Coordination: Dario Salvi and Carl Magnus Olsson.
Development:
- Dario Salvi
- Arvind Goburdhun
- Elin Forsnor
- Felix Morau
- Milo Bengtsson
- Daniel Abella
- Kevin Tsang
- Gent Ymeri
See license file