README.md

Basic Health Units API

This project has a folder called "docker", there is a file called docker-compose.yml which is responsible for building the complete development environment for the project.

Install Docker and Docker-Compose

To use the environment that was designed using the Docker containers you need to have docker and docker-compose installed on your machine, thus, avoiding any conflicts and difficulties in raising the environment and the project.

• Install Docker
• Install Docker-Compose

Using Docker

When cloning the project, simply access the basic-health-units-api project folder and run the setup script below:

    $ cd basic-health-units-api/
    
    $ bash ./docker-setup.sh

Then, inside the Container, execute the following commands:

   $ bash ./application-setup.sh

And to work on a daily basis, use the command below:

   $ bash ./initiate-work.sh

The following containers will be made available:

• basic-health-units-api: Application container with Ruby and the Ruby on Rails framework.
• pgadmin: PgAdmin Container, Tool for PostgreSQL Database Manipulation
• postgres: PostgreSql Database Container
• redis: Redis container, used next to the sidekiq

Configuring the Container Manager

Install Portainer, to manage Local Containers:

Portainer Documentation

After executing the commands above, your environment will be ready.

To view and manipulate the containers, access Portainer and follow the images below:

• Create a username and password:

• Click on the first option to configure the local connection:

• Click on the button Local:

• Click on Containers:

• List of local containers: