Skip to content

Madeyro/aggrandize

Repository files navigation

Aggrandize

Grow with control

Referral Platform

❗ Code base needs refactoring, but it will not be enough probably ❗

Build Setup

Frontend (client)

install dependencies
yarn install
or
npm install

serve with hot reload at localhost:8000
npm run dev

build for production with minification
npm run build

Backend (server)

install dependencies
yarn install
or
npm install

run server (the databse server must be running before startin backend)
npm start

Database

  1. Install CouchDB 2.1.1
  2. create new databse
  3. edit server/src/db/auth.js file accordingly
  4. set env variables COUCHDB_USER with db user login and COUCHDB_PASS with db admin password
  5. run CouchDB from where it is installed ./couchdb/bin/couchdb
  6. create new database and within create document containing db_views.js

Use Cases

See Use Cases file for more information

API

See API docs or generated Postman docs

Technologies used

  • Database: CouchDB
  • Backend: Node.js
  • Middleware: Koa.js
  • Frontend: Vue.js
  • Dependencies: Yarn

Front-end

Template: Vue Light Bootstrap Dashboard

License

Under MIT License.
See license file for more information.