Getting started

<p class="graf graf--p">So you want to set up Chaskiq on Ubuntu to hack on and develop with? We’ll assume that you have Ruby/Rails/Postgre/Redis installed on your Ubuntu system. Let’s begin!.</p><p class="graf graf--p">First. you will need to install the following requirements for installation.</p><ul><li class="graf graf--li"><p class="graf graf--p"><a target="_blank" rel="noopener noreferrer nofollow" href="http://git-scm.com/">Git</a></p></li><li class="graf graf--li"><p class="graf graf--p"><a target="_blank" rel="noopener noreferrer nofollow" href="https://www.ruby-lang.org/">Ruby</a> we recommend rvm to manage ruby versions</p></li><li class="graf graf--li"><p class="graf graf--p"><a target="_blank" rel="noopener noreferrer nofollow" href="http://rubyonrails.org/">Rails</a></p></li><li class="graf graf--li"><p class="graf graf--p"><a target="_blank" rel="noopener noreferrer nofollow" href="http://www.postgresql.org/">PostgreSQL</a></p></li><li class="graf graf--li"><p class="graf graf--p"><a target="_blank" rel="noopener noreferrer nofollow" href="http://redis.io/">Redis</a></p></li><li class="graf graf--li"><p class="graf graf--p"><a target="_blank" rel="noopener noreferrer nofollow" href="http://bundler.io/">Bundler</a></p></li><li class="graf graf--li"><p class="graf graf--p"><a target="_blank" rel="noopener noreferrer nofollow" href="http://www.imagemagick.org/">ImageMagick</a></p></li></ul><p class="graf graf--p">Now that we have installed Chaskiq dependencies, let’s move on to installing Chaskiq itself.</p><h2 class="graf graf--h">Clone Chaskiq</h2><p class="graf graf--p">Clone the Chaskiq repository in ~/chaskiq folder:</p><pre class="graf graf--pre"><code>git clone https://github.com/chaskiq/chaskiq.git ~/chaskiq</code></pre><p class="graf graf--p"><code class="graf code">~</code> indicates home folder, so Chaskiq source code will be available in your home folder.</p><h2 class="graf graf--h">Bootstrap Chaskiq</h2><p class="graf graf--p">Switch to your Chaskiq folder:</p><pre class="graf graf--pre"><code>cd ~/chaskiq</code></pre><h3 class="graf graf--h">Configure Environment</h3><p class="graf graf--p">Note that you will need to set up some environment variables first, the example file is located a .env.example in the root folder. Rename that to .env and add your variables for development.</p><p class="graf graf--p"><strong>Your file should look like this:</strong></p><pre class="graf graf--pre"><code>HOST=http://localhost:3000
ASSET_HOST=http://localhost:3000
WS=ws://localhost:3000/cable



SES_ADDRESS=
SES_USER_NAME=
SES_PASSWORD=
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_S3_BUCKET=
AWS_S3_REGION=
ADMIN_EMAIL=your@email.com
ADMIN_PASSWORD=123456
SNS_CONFIGURATION_SET=metrics
DEFAULT_SENDER_EMAIL=</code></pre><p class="graf graf--p">Important things are: your HOST and WS vars and ADMIN_EMAIL and ADMIN_PASSWORD for initial admin generation</p><p class="graf graf--p"><strong>Install the needed gems</strong></p><pre class="graf graf--pre"><code>bundle install</code></pre><p class="graf graf--p">Now that you have successfully installed gems, run these commands:</p><pre class="graf graf--pre"><code>bundle exec rails db:setup</code></pre><p class="graf graf--p"><strong>Try running the specs:</strong></p><p class="graf graf--p"><code class="graf code">bundle exec rspec</code></p><p class="graf graf--p">All the tests should pass.</p><h2 class="graf graf--h">Start rails server:</h2><p class="graf graf--p">To fully configure development in Chaskiq you will need to run it in a subdomain. That subdomain has to be declared in your /etc/hosts file, and declared in your .env file.</p><p class="graf graf--p"><strong>Example:</strong></p><p class="graf graf--p"><em>/etc/hosts</em></p><pre class="graf graf--pre"><code>127.0.0.1 app.chaskiq.test</code></pre><p class="graf graf--p"><em>chaskiq/.env</em></p><pre class="graf graf--pre"><code>HOST=http://app.chaskiq.test:3000
ASSET_HOST=http://app.chaskiq.test:3000
WS=ws://app.chaskiq.test/cable</code></pre><h2 class="graf graf--h">Now, start the engines 🤖</h2><pre class="graf graf--pre"><code>bundle exec rails server</code></pre><p class="graf graf--p">You should now be able to connect with your Chaskiq app on http://app.chaskiq.test:3000 - try it out!</p><h3 class="graf graf--h">Asset precompilation</h3><p class="graf graf--p">If you want to run the app asset precompilation in parallel in another terminal tab run the following:</p><pre class="graf graf--pre"><code>yarn dev</code></pre><h3 class="graf graf--h">Background tasks</h3><p class="graf graf--p">to run the service background tasks like email sending, file processing. you will need to run</p><pre class="graf graf--pre"><code>bundle exec sidekiq</code></pre><h2 class="graf graf--h">Create New Admin</h2><p class="graf graf--p">The rails admin_generator task will create an admin user for you, you will need to have an ADMIN_EMAIL and ADMIN_PASSWORD on your .env try these credentials:</p><pre class="graf graf--pre"><code>rails admin_generator</code></pre><p class="graf graf--p">Happy hacking! And to get started with that, see Beginner Guide to develop Chaskiq plugins.</p><p class="graf graf--p"></p>

So you want to set up Chaskiq on Ubuntu to hack on and develop with? We’ll assume that you have Ruby/Rails/Postgre/Redis installed on your Ubuntu system. Let’s begin!.

First. you will need to install the following requirements for installation.

Now that we have installed Chaskiq dependencies, let’s move on to installing Chaskiq itself.

Clone the Chaskiq repository in ~/chaskiq folder:

git clone https://github.com/chaskiq/chaskiq.git ~/chaskiq

 indicates home folder, so Chaskiq source code will be available in your home folder.

Note that you will need to set up some environment variables first, the example file is located a .env.example in the root folder. Rename that to .env and add your variables for development.

HOST=http://localhost:3000
ASSET_HOST=http://localhost:3000
WS=ws://localhost:3000/cable



SES_ADDRESS=
SES_USER_NAME=
SES_PASSWORD=
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_S3_BUCKET=
AWS_S3_REGION=
ADMIN_EMAIL=your@email.com
ADMIN_PASSWORD=123456
SNS_CONFIGURATION_SET=metrics
DEFAULT_SENDER_EMAIL=

Important things are: your HOST and WS vars and ADMIN_EMAIL and ADMIN_PASSWORD for initial admin generation

Now that you have successfully installed gems, run these commands:

To fully configure development in Chaskiq you will need to run it in a subdomain. That subdomain has to be declared in your /etc/hosts file, and declared in your .env file.

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

You should now be able to connect with your Chaskiq app on http://app.chaskiq.test:3000 - try it out!

If you want to run the app asset precompilation in parallel in another terminal tab run the following:

to run the service background tasks like email sending, file processing. you will need to run

The rails admin_generator task will create an admin user for you, you will need to have an ADMIN_EMAIL and ADMIN_PASSWORD on your .env try these credentials:

Happy hacking! And to get started with that, see Beginner Guide to develop Chaskiq plugins.