@blz-ospl/cardiovascular v1.0.1

cardiovascular

Cardiovacular is the package host for blz-ospl.

Currently, there is no frontend, but if you want to help out, feel free to start writing some views.

API

Documentation can be found in docs/

Requirements

• NodeJS v10.6.0
• Apache CouchDB v2.2.0
• curl (for testing)

Setup

Environment variables

Create a file named .env in the root of the folder, and populate it with:

COUCHDB_URL="http://<adminuser>:<adminpass>@localhost:5984"
JWT_SECRET="<secret>"

I recommend using this to generate a secret.

Packages

To use anything in scripts/ you'll need the development dependencies.

$ npm i

DB creation

This script will prompt you before deleting and recreating any currently existing databases.

$ node ./scripts/dbsetup.js

Testing

To run the test suite, you'll need to have ./node_modules/.bin/ in $PATH. If you don't want to modify any .*rc files:

$ export PATH="$PATH:./node_modules/.bin/"

Then:

$ npm test

License

Copyright © James Vaughan 2018

Cardiovascular is licensed according to the GNU GPL 3.0 or later.