Skip to content

Latest commit

 

History

History
54 lines (35 loc) · 1.62 KB

README.md

File metadata and controls

54 lines (35 loc) · 1.62 KB

@scipe/librarian

CircleCI

styled with prettier

sci.pe data model. The only source of truth in data. This library wraps all access to CouchDB. No other project should touch CouchDB directly (except for PouchDB), everything needs to go through here.

Note: this module is auto published to npm on CircleCI. Only run npm version patch|minor|major and let CI do the rest.

Smart Contract Executioner

Coding style

Use prettier --single-quote (or npm run format) and:

  • const over let or var whenever possible

API

A high level API to abstract away CouchDB and the side effects of common CRUD operations.

import { Librarian } from '@scipe/librarian';

const librarian = new Librarian(config || req);

Required reading

CLI

librarian --help

Email dev server

npm run watch-email-server

License

@scipe/librarian is dual-licensed under commercial and open source licenses (AGPLv3) based on the intended use case. Contact us to learn which license applies to your use case.