You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.rst
+7-29Lines changed: 7 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -86,11 +86,11 @@ Development Environment with Docker
86
86
Depending on what you are doing, you may need to run at least one BigchainDB
87
87
node. You can use the `docker-compose.yml`_ file to run a node, and perform
88
88
other tasks that depend on the running node. To run a BigchainDB node, (for
89
-
development), you start a MongoDB node, followed by the linked BigchainDB
89
+
development), you start a MongoDB and Tendermint node, followed by the linked BigchainDB
90
90
node::
91
91
92
-
$ docker-compose up -d db
93
-
$ docker-compose up -d bdb-server
92
+
# Implicitly creates a MongoDB and Tendermint instance
93
+
$ docker-compose up -d bigchaindb
94
94
95
95
You can monitor the logs::
96
96
@@ -102,44 +102,22 @@ Tests
102
102
103
103
To run a subset of tests::
104
104
105
-
$ docker-compose run --rm bdb pytest -v tests/test_driver.py
105
+
$ docker-compose run --rm bigchaindb-driver pytest -v tests/test_driver.py
106
106
107
107
.. important:: When running tests, unless you are targeting a test that does
108
108
not require a connection with the BigchainDB server, you need to run the
109
-
BigchainDBand MongoDB servers::
109
+
BigchainDB, MongoDB and Tendermint servers::
110
110
111
-
$ docker-compose up -d db
112
-
$ docker-compose up -d bdb-server
113
-
114
-
115
-
Using RethinkDB as the backend
116
-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
117
-
The default docker-compose file runs MongoDB as a backend. In order to work
118
-
with RethinkDB, one has to use the ``docker-compose.rdb.yml`` file, which
119
-
implies working with `multiple compose files`_. The workflow is the same as
120
-
with MongoDB.
121
-
122
-
First start RethinkDB::
123
-
124
-
$ docker-compose -f docker-compose.rdb.yml up -d db
125
-
126
-
then one BigchainDB server node::
127
-
128
-
$ docker-compose -f docker-compose.rdb.yml up -d bdb-server
129
-
130
-
and run the tests::
131
-
132
-
$ docker-compose -f docker-compose.rdb.yml run --rm bdb pytest -v
111
+
$ docker-compose up -d bigchaindb
133
112
134
113
135
114
Dependency on Bigchaindb
136
115
~~~~~~~~~~~~~~~~~~~~~~~~
137
116
138
-
By default, the development requirements, `BigchainDB server Dockerfile <https://github.com/bigchaindb/bigchaindb-driver/blob/master/compose/server/Dockerfile>`_,
117
+
By default, the development requirements, `BigchainDB server Dockerfile <https://github.com/bigchaindb/bigchaindb-driver/blob/master/compose/bigchaindb_server/Dockerfile>`_,
139
118
and `.travis.yml <https://github.com/bigchaindb/bigchaindb-driver/blob/master/.travis.yml>`_
140
119
are set to depend from BigchainDB's master branch to more easily track changes
0 commit comments