mirror of
https://github.com/bigchaindb/bigchaindb.git
synced 2024-10-13 13:34:05 +00:00
7a718f78d2
* Problem: it's difficult to run/test/compile docs Solution: we already have a nice Makefile, but it's outdated. The idea is to revamp it and make it easy to use. * Problem: Makefile is not documented Solution: Add basic instructions on how to use it in the main README.md * Problem: can't connect to localhost:9984 Solution: make docker expose 9984 by default, so everyone can connect to localhost:9984. * Problem: make clean is TMI Solution: add `@` to remove commands so we don't output all the details about the cleaning * Problem: make clean is too shy Solution: print a message saying that cleaning went well.
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
To know the IP of the instance running, execute in a new terminal make ip.
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.
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