Getting started

So you want to set up Chaskiq on macOS to hack on and develop with? <h2 class="graf graf--h3">Install Chaskiq Dependencies</h2>First. you will need to install the following requirements for installation.<a href="http://git-scm.com/">Git</a><a href="https://www.ruby-lang.org/">Ruby</a> (3.0.3) we recommend rvm to manage ruby versions<a href="http://rubyonrails.org/">Rails</a><a href="http://www.postgresql.org/">PostgreSQL</a><a href="http://redis.io/">Redis</a><a href="http://bundler.io/">Bundler</a><a href="http://www.imagemagick.org/">ImageMagick</a>Now that we have installed Chaskiq dependencies, let’s move on to installing Chaskiq itself.<h2 class="graf graf--h3">Clone Chaskiq</h2>Clone the Chaskiq repository in <code>~/chaskiq</code> folder:<code>git clone https://github.com/chaskiq/chaskiq.git ~/chaskiq</code><code>~</code> indicates home folder, so Chaskiq source code will be available in your home folder.<h2 class="graf graf--h3">Bootstrap Chaskiq</h2>Switch to your Chaskiq folder:<code>cd ~/chaskiq</code><h3 class="graf graf--h4">Configure Environment</h3>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.Your file should look like this: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 generationInstall the needed gems<code>bundle install</code>Now that you have successfully installed gems, run these commands:<code>bundle exec rails db:setup</code>Try running the specs:<code>bundle exec rspec</code>All the tests should pass. <h2 class="graf graf--h3">Start rails server:</h2>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.Example:/etc/hosts127.0.0.1 app.chaskiq.testchaskiq/.envHOST=http://app.chaskiq.test:3000 ASSET_HOST=http://app.chaskiq.test:3000 WS=ws://app.chaskiq.test/cable<h2 class="graf graf--h3">Now, start the engines 🤖</h2><code>bundle exec rails server</code>You should now be able to connect with your Chaskiq app on <a href="https://app.chaskiq.test:3000">http://app.chaskiq.test:3000</a> - try it out!<h3 class="graf graf--h4"> Asset precompilation</h3>If you want to run the app asset precompilation in parallel in another terminal tab run the following:yarn start<h3 class="graf graf--h4">Background tasks</h3>to run the service background tasks like email sending, file processing. you will need to runbundle exec sidekiq<h2 class="graf graf--h3">Create New Admin</h2>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:rails admin_generatorHappy hacking! And to get started with that, see Beginner Guide to develop Chaskiq plugins.

So you want to set up Chaskiq on macOS to hack on and develop with? 

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

 (3.0.3) we recommend rvm to manage ruby versions

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

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.

Ruby (3.0.3) we recommend rvm to manage ruby versions

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

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