Mirroristas/bigchaindb
2
0
Fork 0
mirror of https://github.com/bigchaindb/bigchaindb.git synced 2024-10-13 13:34:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Problem: acceptance-test suite is not documented (#2267)

Browse Source 
* Problem: acceptance-test suite is not documented

Solution: add README.md in the root of the acceptance tests, unify
`Makefile` and commands, remove more cached files when `make clean` is
ran.

* Problem: documentation does not mention Makefile

Solution: update docs with our new and shiny commands
This commit is contained in:
vrde
2018-05-11 09:50:08 +02:00
committed by Troy McConaghy
parent 4a23fa6629
commit 31bae195e7
4 changed files with 57 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/contributing/source/dev-setup-coding-and-contribution-process/run-node-with-docker-compose.md
View File

@@ -2,6 +2,29 @@
## Setting up a single node development environment with ``docker-compose``
### Using the BigchainDB 2.0 developer toolbox
We grouped all useful commands under a simple `Makefile`.
Run a BigchainDB node in the foreground:
```bash
$ make run
```
There are also other commands you can execute:
- `make start`: Run BigchainDB from source and daemonize it (stop it with `make stop`).
- `make stop`: Stop BigchainDB.
- `make logs`: Attach to the logs.
- `make test`: Run all unit and acceptance tests.
- `make test-unit-watch`: Run all tests and wait. Every time you change code, tests will be run again.
- `make cov`: Check code coverage and open the result in the browser.
- `make doc`: Generate HTML documentation and open it in the browser.
- `make clean`: Remove all build, test, coverage and Python artifacts.
- `make reset`: Stop and REMOVE all containers. WARNING: you will LOSE all data stored in BigchainDB.
### Using `docker-compose` directly
The BigchainDB `Makefile` is a wrapper around some `docker-compose` commands we use frequently. If you need a finer granularity to manage the containers, you can still use `docker-compose` directly. This part of the documentation explains how to do that.
```bash
$ docker-compose build bigchaindb
$ docker-compose up -d bdb