Requirements

Ubuntu 19.10 (possibly 19.04)

PLEASE NOTE:  

The installation has been tested on Ubuntu 19.10 but, although it passes the existing tests, 
does not yet work on 20.04.

Ubuntu 20.04 lacks docker-ce at this point so a temporary fix has been added to setup.sh
to substitute docker.io but, but although it passes all 38 of the existing tests, bugs 
remain. The test suite remains to be completed, so this is probably to be expected.

Installation on Ubuntu 18.04 or 16.04 no longer works without much wailing and gnashing of 
teeth (for which evolving nodegremlins appear to be to blame).

openmoney-api

The Openmoney API is a domain driven model of stewards, namespaces, currencies, accounts, and journals. Stewards are the patrons of these namespaces, currencies, accounts and journals.

Install locally

git clone https://github.com/openmoney/openmoney-api
cd openmoney-api

Install, setting initial values:

./setup.sh -u <API URL> -a <admin email>

e.g.

./setup.sh -u om-instance.somewhere.cc -a adi.minster@somewhere.cc

NB, this will generate passwords automatically for the Couchbase administrator and the network administrator. These can then be found in the .env file.

Run locally on port 8080

npm run start

Control-C to quit

Run in a background service

Install PM2 globally:

sudo npm install pm2 -g

Run OpenMoney API service in the background:

pm2 start app.js --name "openmoney-api"

Start and stop DB

npm run start:db
npm run stop:db

Test

npm run test

Local Documentation

http://localhost:8080/docs/

Remote Documentation

https://cloud.openmoney.cc/docs/

Uninstall

./db_uninstall.sh

The following script duplicates the essential later stages of setp.sh, omitting the Node and Docker installation, etc. It is used to re-populate that initial database after it has been cleared using db_uninstall.sh (which was previously named uninstall.sh).

./db_reinstall.sh

License (core OM API code)

Copyright © [2019] [Dominique Legault]

Additional or replacement scripts: 2019/11/03 - 2020/03/24 John Waters

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.