Help Center


Docker for development

https://app.chaskiq.io/rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBbXdEIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--827f2d0b5794f7bb660c48b79e228655bd857bed/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2RkhKbGMybDZaVjkwYjE5c2FXMXBkRnNIYVdscGFRPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--cf24ea7784b3789671bb09c4029aca003c26b32d/me.jpg

Written by Miguel Michelson

updated

The easiest way to test and develop Chaskiq is using the dockerized container. So, in order to get that up and running you will need to install Docker.

Docker on development

Configure Environment

Before continue with the installation you must add some configs to your environment. The environment file is located at the root of the project in a .env file or if you have a .env.example rename it to .env

You have to set the HOST env variable, this is important in order for chaskiq to work on subdomain , but you can set localhost:3000 if you are not going to use helpcenter locally

Once you have installed Docker on your local environment you can run the build command in order to create the docker image instance.

docker-compose build

Run database migrations & seed data

Create database

docker-compose run rails rake db:create

Load database structure

docker-compose run rails rake db:schema:load

Seed the initial data

docker-compose run rails rake db:seed

Add a default admin for the forst application generated on the seeds step, check your .env file for ADMIN_EMAIL & ADMIN_PASSWORD env vars!

docker-compose run rails rake admin_generator

At this point you are ready to go to start the engines

Run main rails app

docker-compose up rails

You can also run with docker-compose run --service-ports rails , in order to get the tty session, useful if you are going to use binding.pry or debugger on rails development

Run webpacker assets (separately)

In a second terminal tab run this

docker-compose up webpacker

You may install the js dependences with yarn install, to do so run this command:

docker-compose run webpacker yarn install

Run sidekick to handle background processes

in a third tab run this

docker-compose up sidekiq

Run all services in one command

docker-compose up

Enter the matrix (aka bash session)

To enter the machine to a bash session inside the project folder run:

docker-compose run runner
Note: docker-compose run runner is exactly the same as docker-compose run web /bin/bash (but shorter 😉).




This docker recipe was based on the Evil Martians blog post