mirror of
https://github.com/bigchaindb/bigchaindb.git
synced 2024-10-13 13:34:05 +00:00
8086f75ec8
Solution: update the documentation to reflect this. I've also removed the documentation about the event plugin API. That part needs to be refactored to work properly with BigchainDB 2.0. We can reintroduce it later.
BigchainDB Server
BigchainDB is a blockchain database.
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 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
BigchainDB should be reachable now on http://localhost:9984/.
There are also other commands you can execute:
make start: Run BigchainDB from source and daemonize it (stop it withmake stop).make stop: Stop BigchainDB.make logs: Attach to the logs.make test: Run all tests.make test-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.
To view all commands available, run make.
Get Started with BigchainDB Server
Quickstart
Set Up & Run a Dev/Test Node
Run BigchainDB Server with Docker
Run BigchainDB Server with Vagrant
Run BigchainDB Server with Ansible
Links for Everyone
- BigchainDB.com - the main BigchainDB website, including newsletter signup
- Roadmap
- Blog
Links for Developers
- All BigchainDB Documentation
- BigchainDB Server Documentation
- CONTRIBUTING.md - how to contribute
- Community guidelines
- Open issues
- Open pull requests
- Gitter chatroom
Legal
- Licenses - open source & open content
- Imprint
- Contact Us