# backd javascript client

[![Build Status](https://travis-ci.org/backd-io/backd-js.svg?branch=master)](https://travis-ci.org/backd-io/backd-js)


## develop quickstart

Ensure you have node 6.x or 7.x, both are targeted on tests (probably newer will do but not fully tested).

This steps will get the last `integration` tested binary.

To run the tests you need to have `docker` and `docker-compose` in order to get the last `integration` version of the binaries. Test expect to have the API running on 127.0.0.1:8080.

```

  # install dependencies
  npm install

  # export some random 'admin' credentials to be used by the tests

  export ADMIN_NAME=""
  export ADMIN_EMAIL=""
  export ADMIN_PASSWORD=""

  # start a ephemeral mongodb instance (as daemon, remove -d to output)
  docker-compose up -d mongodb

  # bootstap the database with the administrator user and roles
  docker-compose run -e ADMIN_NAME -e ADMIN_EMAIL -e ADMIN_PASSWORD bootstrap

  # start a sample api instance (as daemon, remove -d to output)
  docker-compose up -d api

  # to ensure local environment works
  npm run test


```


## documentation

Currently documentation is been written to be published at backd.io.