diff --git a/README.md b/README.md index d268cc4f..3c89429e 100644 --- a/README.md +++ b/README.md @@ -53,11 +53,22 @@ See [CLI](#CLI) for information on how to add modules back into the server. ## Dependencies To run the development server, or run tests (tip: run `make test` to easily -run tests), you'll need a running MongoDB server. The easiest way to get -one is using Docker. Simply run this command and you'll have the server running: +run tests), you'll need a running MongoDB server. We plan to add more service +dependencies in the future, so we are using +[Docker](https://www.docker.com/) and +[Docker Compose](https://docs.docker.com/compose/) to create and destroy +development environments. + +To create, run the following from the repository root: ```console -docker run -d -p 27017:27017 mongo:3.0.15-wheezy +docker-compose up -d +``` + +To destroy: + +```console +docker-compose down ``` # Contributing diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 00000000..3d9b6a8f --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,6 @@ +version: '3' +services: + mongo: + image: mongo:3.0.15-wheezy + ports: + - 27017:27017