https://github.com/dadi/api-couchdb

A CouchDB adapter for DADI API
https://github.com/dadi/api-couchdb

couchdb dadi dadi-api database

Last synced: 2 months ago
JSON representation

A CouchDB adapter for DADI API

• Host: GitHub
• URL: https://github.com/dadi/api-couchdb
• Owner: dadi
• Created: 2017-02-12T02:14:38.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2019-05-03T08:04:09.000Z (about 7 years ago)
• Last Synced: 2025-10-19T04:28:16.241Z (8 months ago)
• Topics: couchdb, dadi, dadi-api, database
• Language: JavaScript
• Homepage:
• Size: 436 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# API CouchDB Adapter

[![npm (scoped)](https://img.shields.io/npm/v/@dadi/api-couchdb.svg?maxAge=10800&style=flat-square)](https://www.npmjs.com/package/@dadi/api-couchdb)

[![coverage](https://img.shields.io/badge/coverage-84%25-yellow.svg?style=flat-square)](https://github.com/dadi/api-couchdb)

[![Build Status](https://travis-ci.org/dadi/api-couchdb.svg?branch=master)](https://travis-ci.org/dadi/api-couchdb)

[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](http://standardjs.com/)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)

## Requirements

* [DADI API](https://www.npmjs.com/package/@dadi/api) Version 2.0.0 or greater

## 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:

```bash

$ 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..json`

For example:

```

couchdb.development.json

couchdb.qa.json

couchdb.production.json

```

### Application Anatomy

```sh

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]