2018-08-16 12:31:32 +02:00
<!-- -
2020-04-06 11:52:18 +02:00
Copyright © 2020 Interplanetary Database Association e.V.,
BigchainDB and IPDB software contributors.
2018-08-16 12:31:32 +02:00
SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0)
Code is Apache-2.0 and docs are CC-BY-4.0
--->
2018-06-08 11:31:10 +02:00
<!-- - There is no shield to get the latest version
(including pre-release versions) from PyPI,
so show the latest GitHub release instead.
--->
2018-08-08 16:46:23 +02:00
2016-04-11 14:47:16 +02:00
[![Codecov branch ](https://img.shields.io/codecov/c/github/bigchaindb/bigchaindb/master.svg )](https://codecov.io/github/bigchaindb/bigchaindb?branch=master)
2018-06-09 09:31:52 +02:00
[![Latest release ](https://img.shields.io/github/release/bigchaindb/bigchaindb/all.svg )](https://github.com/bigchaindb/bigchaindb/releases)
[![Status on PyPI ](https://img.shields.io/pypi/status/bigchaindb.svg )](https://pypi.org/project/BigchainDB/)
2018-12-10 18:10:58 +01:00
[![Travis branch ](https://img.shields.io/travis/bigchaindb/bigchaindb/master.svg )](https://travis-ci.com/bigchaindb/bigchaindb)
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-09-29 09:57:25 +02:00
# BigchainDB Server
2016-04-11 15:50:30 +02:00
2018-06-09 09:32:58 +02:00
BigchainDB is the blockchain database. This repository is for _BigchainDB Server_ .
2016-04-11 15:50:30 +02:00
2018-06-08 11:31:10 +02:00
## The Basics
2018-03-22 17:12:39 +01:00
2018-06-08 11:31:10 +02:00
* [Try the Quickstart ](https://docs.bigchaindb.com/projects/server/en/latest/quickstart.html )
* [Read the BigchainDB 2.0 whitepaper ](https://www.bigchaindb.com/whitepaper/ )
* [Check out the _Hitchiker's Guide to BigchainDB_ ](https://www.bigchaindb.com/developers/guide/ )
## Run and Test BigchainDB Server from the `master` Branch
Running and testing the latest version of BigchainDB Server is easy. Make sure you have a recent version of [Docker Compose ](https://docs.docker.com/compose/install/ ) installed. When you are ready, fire up a terminal and run:
```text
2018-03-22 17:12:39 +01:00
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:
2018-06-08 11:31:10 +02:00
* `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.
2016-02-23 15:31:53 +01:00
2018-06-08 11:31:10 +02:00
To view all commands available, run `make` .
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 )
2018-06-08 11:31:10 +02:00
* [CONTRIBUTING.md ](.github/CONTRIBUTING.md ) - how to contribute
2016-02-23 15:31:53 +01:00
* [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/ )