Getting started

<p class="graf graf--p">The easiest way to test and <b>develop</b> Chaskiq is using the dockerized container. So, in order to get that up and running, you will need to <a href="https://docs.docker.com/install/">install Docker</a>. </p><p class="graf graf--p"><b>NOTE: PLEASE DO NOT USE THIS DOCKER RECIPE FOR PRODUCTION. (check the production articles on this help center).</b></p><h2 class="graf graf--h3">Docker on development</h2><h3 class="graf graf--h4">Configure Environment</h3><p class="graf graf--p">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 <b>.env</b> file or if you have a <b>.env.example</b> rename it to <b>.env</b></p><blockquote class="graf graf--blockquote"><b>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</b></blockquote><p class="graf graf--p"><b>example:</b></p><p class="graf graf--p"><i>/etc/hosts</i></p><p>127.0.0.1 app.chaskiq.test</p><p class="graf graf--p"><i>chaskiq/.env</i></p><p>HOST=http://app.chaskiq.test:3000<br/>ASSET_HOST=http://app.chaskiq.test:3000<br/>WS=ws://app.chaskiq.test/cable</p><p class="graf graf--p">Once you have installed Docker on your local environment you can run the build command in order to create the docker image instance.</p><p>docker-compose build</p><h3 class="graf graf--h4">Install app dependencies:</h3><p>docker-compose run rails bundle install</p><p>docker-compose run rails yarn install</p><h3 class="graf graf--h4">Run database migrations &amp; seed data</h3><p class="graf graf--p">Setup Database</p><p>docker-compose run rails rails db:setup </p><p class="graf graf--p">db:setup is the same as the following 3 steps:</p><p class="graf graf--p">these are optional if you already did the db:setup</p><h3 class="graf graf--h4">Create database</h3><p>docker-compose run rails rails db:create</p><h3 class="graf graf--h4">Load database structure</h3><p>docker-compose run rails rails db:schema:load</p><h3 class="graf graf--h4">Seed the initial data</h3><p>docker-compose run rails rails db:seed</p><h3 class="graf graf--h4">--- </h3><h3 class="graf graf--h4">Default Admin</h3><p class="graf graf--p">Add a default admin for the forst application generated on the seeds step, <b>check your .env file for ADMIN_EMAIL &amp; ADMIN_PASSWORD env vars!</b></p><p>docker-compose run rails rake admin_generator</p><p class="graf graf--p">At this point, you are ready to go to start the engines</p><h3 class="graf graf--h4">Run main rails app</h3><p>docker-compose up rails</p><p class="graf graf--p">You can also run with <b>docker-compose run --service-ports rails</b>, to get the <i>tty</i> session, useful if you are going to use <i>binding.pry</i> or debugger on rails development</p><h3 class="graf graf--h4">Run sidekick to handle background processes</h3><p class="graf graf--p">in a third tab run this</p><p>docker-compose up sidekiq</p><h3 class="graf graf--h4">Run all services in one command</h3><p>docker-compose up</p><h3 class="graf graf--h4">Enter the matrix (aka bash session)</h3><p class="graf graf--p">To enter the machine to a bash session inside the project folder run:</p><p>docker-compose run runner</p><blockquote class="graf graf--blockquote"><b>Note</b>: <code>docker-compose run runner</code> is exactly the same as <code>docker-compose run web /bin/bash</code> (but shorter 😉).</blockquote><p></p><p class="graf graf--p"></p><p class="graf graf--p"><i>This docker recipe was based on the </i><a href="https://evilmartians.com/chronicles/ruby-on-whales-docker-for-ruby-rails-development">Evil Martians blog post</a></p>

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

NOTE: PLEASE DO NOT USE THIS DOCKER RECIPE FOR PRODUCTION. (check the production articles on this help center).

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

HOST=http://app.chaskiq.test:3000
ASSET_HOST=http://app.chaskiq.test:3000
WS=ws://app.chaskiq.test/cable

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

db:setup is the same as the following 3 steps:

these are optional if you already did the db:setup

docker-compose run rails rails db:schema:load

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

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

Run sidekick to handle background processes

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

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

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. 

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