search

enjalot / blockbuilder

Create, fork and edit d3.js code snippets for use with bl.ocks.org right in the browser, no terminal required.
Other
323 stars 59 forks source link

document new docker container feature for local dev #238

Closed micahstubbs closed 5 years ago

micahstubbs commented 5 years ago

ok @hydrosquall please do add a section here that describes how to optionally run redis and mongodb in a docker container https://github.com/enjalot/blockbuilder/wiki/Development#setting-up-databases

forked off from this PR comment https://github.com/enjalot/blockbuilder/pull/232#issuecomment-496301456

hydrosquall commented 5 years ago

I took a pass at this task in this commit: https://github.com/enjalot/blockbuilder/wiki/Development/6f2391924ecfb36ed451e93524c507b62e7b907b

I've provided the modified text as a comment below for ease of future record-keeping.

OS X

Method 1: Using Docker

The simplest way to get started in blockbuilder is to use docker. To begin, install the app through Homebrew.

brew cask install docker
# From Application launcher, open the Docker app after installation completes

Next, from within the blockbuilder directory, run the following command. Docker-compose will read from the docker-compose file to download and build the appropriate mongodb and redis images from Docker Hub registry. This may take a while, but it only needs to be done once. After downloading the images, docker will also launch the applications on the ports that blockbuilder expects.

# The -d flag runs the containers in detached mode, so that you can use the terminal for other things
docker-compose up -d

That's it, you're done! When you're done with your databases, run the following command to shut down your Docker network from within the blockbuilder directory.

docker-compose down

You can now proceed to the "Running Server" portion of this guide. If you're not using Docker, read the next section for an alternate way to run the databases.

Method 2: Using Homebrew Manually

previous content under the OSX section.

micahstubbs commented 5 years ago

docs look great, thanks for doing this @hydrosquall 🙏

will close this issue as complete.