@dadi/api-couchdb

    0.2.0 • Public • Published

    API CouchDB Adapter

    npm (scoped) coverage Build Status JavaScript Style Guide semantic-release

    Requirements

    Tests

    To run the test suite you'll need a CouchDB server running on localhost with the default port of 5984. If you've changed the default port, modify the test configuration file at config/couchdb.test.json. This file is created from config/couchdb.test.json.sample the first time the test suite is run.

    Run the tests:

    $ git clone https://github.com/dadi/api-couchdb.git
    cd api-couchdb
    $ npm test

    Configure

    Configuration Files

    Configuration settings are defined in JSON files within a /config directory at the root of your API application. DADI API has provision for multiple configuration files, one for each environment that your API is expected to run under: development, qa and production.

    The naming convention for CouchDB configuration files follows the format couchdb.<environment>.json

    For example:

    couchdb.development.json
    couchdb.qa.json
    couchdb.production.json
    

    Application Anatomy

    my-api/
      config/            # contains environment-specific 
                         # configuration properties 
        config.development.json
        config.qa.json
        config.production.json
        couchdb.development.json
        couchdb.qa.json
        couchdb.production.json
     
      main.js            # the entry point of the app 
     
      package.json
     
      workspace/
        collections/     # collection schema files 
        endpoints/       # custom Javascript endpoints 
     

    Configuration

    [TODO]

    Keywords

    none

    Install

    npm i @dadi/api-couchdb

    DownloadsWeekly Downloads

    5

    Version

    0.2.0

    License

    ISC

    Last publish

    Collaborators

    • jeanluc.thiebaut
    • josephdenne
    • jimlambie
    • arthurmingard
    • eduardoboucas
    • abovedave
    • adamkdean