coinstac-server-core

3.0.0 • Public • Published

COINSTAC Server Core

COINSTAC core server functionality. Documentation.

Install

Install in your project to use programmatically:

npm install coinstac-server-core --save

Or, install globally for easy CLI use:

npm install coinstac-server-core

Usage

Official API documentation may be found here.

Programmatically

This library has one chief export, a server function:

const coinstacServerCore = require('coinstac-server-core');
 
constacServerCore({
  // External database URL:
  dbUrl: 'https://my-cloud.cloudant.com/',
 
  // Keep local docs memory (using memdown):
  inMemory: true,
 
  // Seed the consortia database:
  seed: [{/*...*/}, {/*...*/}]
})
  .then(remotePipelineRunnerPoolInstance => { ... })
  .catch(error => console.error(error));

CLI

Use the coinstac-server-core utility. Pass the --help flag to see all the options:

$ coinstac-server-core --help
 
  Usage: coinstac-server-core [options]
 
  Options:
 
    -h, --help               output usage information
    -V, --version            output the version number
    -db, --database [value]  Database connection string
    -m, --memory             Use in-memory database
    -s, --seed [value]       Seed the consortia database
 
  Databases:
 
    Specify the CouchDB database connection as a URL string:
 
    $ coinstac-server-core --database http://localhost:5984
 
    Seeding:
 
    Pass the '--seed' flag to use the built-in seed documents. You may also pass
    in the path to your custom consortia JSON file:
 
    $ coinstac-server-core --seed ./path/to/my/docs.json

License

MIT. See LICENSE for details.

Readme

Keywords

Package Sidebar

Install

npm i coinstac-server-core

Weekly Downloads

3

Version

3.0.0

License

MIT

Last publish

Collaborators

  • cdaringe
  • rsskmr
  • swashcap