mirror of
https://github.com/planetmint/planetmint.git
synced 2025-03-30 15:08:31 +00:00
78 lines
3.6 KiB
Markdown
78 lines
3.6 KiB
Markdown
<!---
|
|
Copyright © 2020 Interplanetary Database Association e.V.,
|
|
Planetmint and IPDB software contributors.
|
|
SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0)
|
|
Code is Apache-2.0 and docs are CC-BY-4.0
|
|
--->
|
|
|
|
<!--- There is no shield to get the latest version
|
|
(including pre-release versions) from PyPI,
|
|
so show the latest GitHub release instead.
|
|
--->
|
|
|
|
[](https://codecov.io/github/planetmint/planetmint?branch=master)
|
|
[](https://github.com/planetmint/planetmint/releases)
|
|
[](https://pypi.org/project/Planetmint)
|
|
[](https://app.travis-ci.com/planetmint/planetmint)
|
|
[](https://gitter.im/planetmint/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
|
# Planetmint Server
|
|
|
|
Planetmint is the blockchain database. This repository is for _BigchainDB Server_.
|
|
|
|
## The Basics
|
|
|
|
* [Try the Quickstart](https://docs.planetmint.com/projects/server/en/latest/quickstart.html)
|
|
* [Read the Planetmint 2.0 whitepaper](https://www.planetmint.com/whitepaper/)
|
|
* [Check out the _Hitchiker's Guide to BigchainDB_](https://www.planetmint.com/developers/guide/)
|
|
|
|
## Run and Test Planetmint Server from the `master` Branch
|
|
|
|
Running and testing the latest version of Planetmint 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
|
|
git clone https://github.com/planetmint/planetmint.git
|
|
cd planetmint
|
|
make run
|
|
```
|
|
|
|
Planetmint should be reachable now on `http://localhost:9984/`.
|
|
|
|
There are also other commands you can execute:
|
|
|
|
* `make start`: Run Planetmint from source and daemonize it (stop it with `make stop`).
|
|
* `make stop`: Stop Planetmint.
|
|
* `make logs`: Attach to the logs.
|
|
* `make lint`: Lint the project
|
|
* `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 docs`: 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 Planetmint.
|
|
|
|
To view all commands available, run `make`.
|
|
|
|
## Links for Everyone
|
|
|
|
* [Planetmint.com](https://www.planetmint.com/) - the main Planetmint website, including newsletter signup
|
|
* [Roadmap](https://github.com/planetmint/org/blob/master/ROADMAP.md)
|
|
* [Blog](https://medium.com/the-planetmint-blog)
|
|
* [Twitter](https://twitter.com/Planetmint)
|
|
|
|
## Links for Developers
|
|
|
|
* [All Planetmint Documentation](https://docs.planetmint.com/en/latest/)
|
|
* [Planetmint Server Documentation](https://docs.planetmint.com/projects/server/en/latest/index.html)
|
|
* [CONTRIBUTING.md](.github/CONTRIBUTING.md) - how to contribute
|
|
* [Community guidelines](CODE_OF_CONDUCT.md)
|
|
* [Open issues](https://github.com/planetmint/planetmint/issues)
|
|
* [Open pull requests](https://github.com/planetmint/planetmint/pulls)
|
|
* [Gitter chatroom](https://gitter.im/planetmint/planetmint)
|
|
|
|
## Legal
|
|
|
|
* [Licenses](LICENSES.md) - open source & open content
|
|
* [Imprint](https://www.planetmint.com/imprint/)
|
|
* [Contact Us](https://www.planetmint.com/contact/)
|