README.md 1 KB
Newer Older
luca de carne's avatar
luca de carne committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
# Commonshood Toolkit Repository
This repository contains the toolkit implementation of the Commonshood App. We use Strongloop Loopback as RESTful API framework.

## Configuration
`config.js.template` contains the server configuration parameters. `server/datasources.json` contains the server datasource configuration parameters. `server/model-config.json` contains the models configuration parameters like the datasources of the model, or wich API endpoint should be exposed by the server.

## Starting the server
*PLEASE BE CAREFUL: Be sure that a mongodb instance is running before attempting to start the server*

#### Technologies
- Loopback
- Nodejs
- Web3js
- RabbitMQ
- Socket.io

---

#### Show Documentation

Install `jsdoc` first:

``` sh
$ npm i -g jsdoc
```

Then run it on the `client`, `server`, `common` and `extra-docs` directories in `recursive mode`:
``` sh
$ cd /path/to/project/root
$ jsdoc -r server client common extra-docs
```

Finally open `out/index.html` with a web browser to see the built website