juancgarza/hsdemy

Run Hsdemy using Docker

This guide will help you get started to setup the project using Docker, and keep using it as part of your development process.

Table of contents

• Installing Docker
• Running Hsdemy
• Stop Hsdemy
• Restoring DB
• Debugging
• Icalia Guides

Installing Docker

The first thing you need to do before start is to install Docker

https://www.docker.com/products/docker

If Docker was successfully installed, you should be good to go.

Running Hsdemy

To run Hsdemy you can simple execute the following command inside the project directory:

% docker-compose up -d

That command will lift every service Hsdemy needs, such as the rails server, postgres.

It may take a while before you see anything, you can follow the logs of the containers with:

% docker-compose logs

Once you see an output like this:

web_1  | => Booting Puma
web_1  | => Rails 4.2.0 application starting in development on http://0.0.0.0:3000
web_1  | => Run `rails server -h` for more startup options
web_1  | => Ctrl-C to shutdown server
web_1  | Puma starting in single mode...
web_1  | * Version 3.4.0 (ruby 2.2.5-p319), codename: Owl Bowl Brawl
web_1  | * Min threads: 0, max threads: 16
web_1  | * Environment: development
web_1  | * Listening on tcp://0.0.0.0:3000
web_1  | Use Ctrl-C to stop

This means the project is up and running. It is worth mention that the docker-compose command will create the database if is not there yet.

Stop Hsdemy

In order to stop Hsdemy as a whole you can run:

% docker-compose stop

This will stop every container, but if you need to stop one in particular, you can specify it like:

% docker-compose stop web

web is the service name located on the docker-compose.yml file, there you can see the services name and stop each of them if you need to.

Restoring DB

You probably won't be working with a blank database, so once you are able to run Hsdemy you can restore the database, to do it, first stop all services:

% docker-compose stop

Then just lift up the db service:

% docker-compose up -d db

The next step is to login to the database container:

% docker exec -ti hsdemy_db_1 bash

This will open up a bash session in to the database container.

Up to this point we just need to download or ask the project leader for a database dump and copy under hsdemy/db/dumps, this directory is mounted on the container, so you will be able to restore it with:

root@a3f695b39869:/# bin/restoredb hsdemy_dev db/dumps/<databaseDump>

If you want to see how this script works, you can find it under bin/restoredb

Once the script finishes its execution you can just exit the session from the container and lift the other services:

% docker-compose up -d

Debugging

We know you love to use debugger, and who doesn't, that's why we put together a script to attach the web container service into your terminal session.

What we mean by this, is that if you add a debugger or binding.pry on a part of the code, you can run:

% bin/attach web

This will display the logs from the rails app, as well as give you access to stop the execution on the debugging point as you would expect.

Take note that if you kill this process you will kill the web service, and you will probably need to lift it up again.

Icalia Guides

Remember you can always rely on the Icalia Guides to a better development and internal progamming style:

• Rails Guides