mirror of
https://github.com/bigchaindb/bigchaindb.git
synced 2024-10-13 13:34:05 +00:00
2386ca9d71
* Problem: core.py contains an unused class, `Bigchain` Solution: Remove core.py. Refactor BigchainDB Class to remove inheritance from Bigchain. * Problem: core.py contains an unused class, `Bigchain` Solution: Remove core.py. Refactor BigchainDB Class to remove inheritance from Bigchain. * Fixed flake8 complaint about too many blank lines * Attempting to fix Sphinx docs. This may result in some redundant commits, as I don't know what I'm doing, and I can't experiment without running the CI... Sorry in advance! * Attempting to fix Sphinx docs. This may result in some redundant commits, as I don't know what I'm doing, and I can't experiment without running the CI... Sorry in advance! * Updating from master changed BigchainDB.process_post_response to a private method, so I had to align with that. * Fixed a couple stale references to bigchaindb.Bigchain in docstrings * Missed a reference to `Bigchain` in a patch call... * Problem: BigchainDB class should be part of project root Solution: Removed the /tendermint directory and moved its contents to project root * Problem: Flake8 complained that imports were not at the top of the file Solution: Had to play around with the order of imports to avoid cyclic dependencies, but its working and style compliant now * Problem: Stale reference to /tendermint directory in the index Solution: Removed the references to /tendermint * Problem: Flake8 complaining of unused import in __init__.py Solution: The import is there so I can import App directly from bigchaindb, rather than from bigchaindb.core (which I think improves code readability. I added a # noqa to silence Flake8. * Problem: Stale references to `bigchaindb.tendermint.BigchainDB` in the rst files cause Sphinx to fail Solution: Updated the autodoc files to use `bigchaindb.BigchainDB` instead * Problem: Stale reference to the `tendermint` directory in an @patch in a disabled test Solution: Updated the @patch for completeness * Problem: BigchainDB class should be part of project root Solution: Removed the /tendermint directory and moved its contents to project root * Problem: Flake8 complained that imports were not at the top of the file Solution: Had to play around with the order of imports to avoid cyclic dependencies, but its working and style compliant now * Problem: Stale reference to /tendermint directory in the index Solution: Removed the references to /tendermint * Problem: Flake8 complaining of unused import in __init__.py Solution: The import is there so I can import App directly from bigchaindb, rather than from bigchaindb.core (which I think improves code readability. I added a # noqa to silence Flake8. * Problem: Stale references to `bigchaindb.tendermint.BigchainDB` in the rst files cause Sphinx to fail Solution: Updated the autodoc files to use `bigchaindb.BigchainDB` instead * Problem: Stale reference to the `tendermint` directory in an @patch in a disabled test Solution: Updated the @patch for completeness
BigchainDB Server
BigchainDB is the blockchain database. This repository is for BigchainDB Server.
The Basics
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 installed. When 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 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.
To view all commands available, run make.
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