2016-05-13 16:57:45 +02:00
[![PyPI ](https://img.shields.io/pypi/status/bigchaindb.svg?maxAge=2592000 )](https://pypi.python.org/pypi/BigchainDB)
2016-02-12 02:26:59 +01:00
[![PyPI ](https://img.shields.io/pypi/v/bigchaindb.svg )](https://pypi.python.org/pypi/BigchainDB)
2016-04-11 14:47:16 +02:00
[![Travis branch ](https://img.shields.io/travis/bigchaindb/bigchaindb/master.svg )](https://travis-ci.org/bigchaindb/bigchaindb)
[![Codecov branch ](https://img.shields.io/codecov/c/github/bigchaindb/bigchaindb/master.svg )](https://codecov.io/github/bigchaindb/bigchaindb?branch=master)
2016-10-21 10:25:07 +02:00
[![Documentation Status ](https://readthedocs.org/projects/bigchaindb-server/badge/?version=latest )](https://docs.bigchaindb.com/projects/server/en/latest/)
2016-05-13 16:57:45 +02:00
[![Join the chat at https://gitter.im/bigchaindb/bigchaindb ](https://badges.gitter.im/bigchaindb/bigchaindb.svg )](https://gitter.im/bigchaindb/bigchaindb?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge& utm_content=badge)
2016-04-11 16:19:20 +02:00
2016-02-10 19:55:33 +01:00
2016-09-29 09:57:25 +02:00
# BigchainDB Server
2016-04-11 15:50:30 +02:00
2018-02-19 11:06:06 +01:00
BigchainDB is a blockchain database.
2016-04-11 15:50:30 +02:00
2018-03-22 17:12:39 +01:00
## Run and test BigchainDB from the `master` branch
Running and testing the latest version of BigchainDB is easy. Make sure you have a recent version of [Docker Compose installed ](https://docs.docker.com/compose/install/ ) in your host.
Whenever you are ready, fire up a terminal and run:
```
git clone https://github.com/bigchaindb/bigchaindb.git
cd bigchaindb
make run
```
2018-03-23 14:39:43 +01:00
BigchainDB should be reachable now on `http://localhost:9984/` .
2018-03-22 17:12:39 +01:00
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.
2018-05-11 09:50:08 +02:00
- `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.
2018-03-22 17:12:39 +01:00
- `make cov` : Check code coverage and open the result in the browser.
- `make doc` : Generate HTML documentation and open it in the browser.
2018-03-23 14:39:43 +01:00
- `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.
2018-03-22 17:12:39 +01:00
To view all commands available, run `make` .
2016-09-29 09:57:25 +02:00
## Get Started with BigchainDB Server
2016-02-23 15:31:53 +01:00
2016-10-10 16:55:39 +02:00
### [Quickstart](https://docs.bigchaindb.com/projects/server/en/latest/quickstart.html)
2017-11-15 12:01:46 +01:00
### [Set Up & Run a Dev/Test Node](https://docs.bigchaindb.com/projects/server/en/latest/dev-and-test/index.html)
2016-10-10 16:55:39 +02:00
### [Run BigchainDB Server with Docker](https://docs.bigchaindb.com/projects/server/en/latest/appendices/run-with-docker.html)
2017-09-14 14:00:13 +02:00
### [Run BigchainDB Server with Vagrant](https://docs.bigchaindb.com/projects/server/en/latest/appendices/run-with-vagrant.html)
### [Run BigchainDB Server with Ansible](https://docs.bigchaindb.com/projects/server/en/latest/appendices/run-with-ansible.html)
2016-02-23 15:31:53 +01:00
## Links for Everyone
2016-09-29 14:15:51 +02:00
2016-02-23 15:31:53 +01:00
* [BigchainDB.com ](https://www.bigchaindb.com/ ) - the main BigchainDB website, including newsletter signup
2016-06-03 11:22:56 +02:00
* [Roadmap ](https://github.com/bigchaindb/org/blob/master/ROADMAP.md )
2016-02-23 15:31:53 +01:00
* [Blog ](https://medium.com/the-bigchaindb-blog )
* [Twitter ](https://twitter.com/BigchainDB )
## Links for Developers
2016-09-29 14:15:51 +02:00
2016-10-10 16:55:39 +02:00
* [All BigchainDB Documentation ](https://docs.bigchaindb.com/en/latest/ )
* [BigchainDB Server Documentation ](https://docs.bigchaindb.com/projects/server/en/latest/index.html )
2016-02-23 15:31:53 +01:00
* [CONTRIBUTING.md ](CONTRIBUTING.md ) - how to contribute
* [Community guidelines ](CODE_OF_CONDUCT.md )
* [Open issues ](https://github.com/bigchaindb/bigchaindb/issues )
* [Open pull requests ](https://github.com/bigchaindb/bigchaindb/pulls )
* [Gitter chatroom ](https://gitter.im/bigchaindb/bigchaindb )
## Legal
2016-09-29 14:15:51 +02:00
2016-02-23 15:31:53 +01:00
* [Licenses ](LICENSES.md ) - open source & open content
* [Imprint ](https://www.bigchaindb.com/imprint/ )
* [Contact Us ](https://www.bigchaindb.com/contact/ )