financier

⚙ Gitlab — 💰 Production app — Staging app — 📗 Staging Docs — 📢 Trello — 🕸 Website — 🐳 Docker

A web-based, offline-first app. Built with Angular 1 and PouchDB.

NOTE: This is a fork of the main financier app written by aeharding. Thanks for all of your hard work, and THANK YOU for open sourcing the front end!

The main differences in this repo are scripts for getting financier up and running quickly on a clean ubuntu 16.x install, and requests to /db are proxied to a local CouchDB install.

Ubuntu 16.x Install

On a clean ubunutu install:

First create a non-root user and log in as this user:

adduser financier
# follow the prompts

# This gives financier user sudo access
usermod -aG sudo financier

# Log in as this user
su financier
cd ~/

Now once you're logged in as a non-root user, run:

bash <(curl -s https://gitlab.com/caleb3141/financier/raw/master/install/ubuntu_install.sh)

Notes:

• When the CouchDB installation prompts you for input, use the defaults (and be sure to enter an admin password)

This will:

1. Install CouchDB 2.x
2. Install node js
3. Install git
4. Download financier (from this repo)
5. Configure CouchDB
6. Start the financier web app and daemonize it.

Develop

npm start
npm install

Test

npm test
# or continuous: `npm run test-watch`

Build (for production)

npm run build

Run locally

gulp build
npm run-script docs # generate jsdoc documentation
node ./api

Docs

Local docs would be http://localhost:8080/docs.

Generate with npm run docs.

CouchDB setup

node ./install/setup_couchdb.js