loftwah / rails-full-ci-cd

A demo repo for a full CI and CD system around Rails.

Loftwah's Rails Demo App

This is a demo app for Rails. I will do random stuff here so please don't use it for anything you care about.

The info for this is here

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Ensure you have Docker and Docker Compose installed on your machine.

Installing and Running

1. Clone the repository:

git clone [e-mail]:loftwah/rails-full-ci-cd.git

1. Change into the project directory:

cd rails-full-ci-cd

1. Copy the example environment variables file and fill it out with your own configuration: rails secret for SECRET_KEY_BASE and rails credentials:edit for DATABASE_PASSWORD:

cp .env.example .env

4. Start the application with Docker Compose:

docker compose up

5. In a new terminal, create and migrate the database:

docker compose exec web rails db:create db:migrate

Your application should now be running at localhost:3000. Enjoy exploring the Rails Demo application!

Access the Rails console with:

docker compose exec web rails console

Test a resque job with:

TestJob.perform_later

It should give you an output like this:

Loading development environment (Rails 7.0.6)
irb(main):001:0> TestJob.perform_later
Enqueued TestJob (Job ID: b6741ea0-ff35-48e8-aa57-0cd27fa48ef3) to Async(default)
=> 
#<TestJob:0x0000ffffb4fa3d68
 @arguments=[],
 @exception_executions={},
 @executions=0,
 @job_id="b6741ea0-ff35-48e8-aa57-0cd27fa48ef3",
 @priority=nil,
 @provider_job_id="b8ec361e-229f-4272-bc44-2ad31c2d947c",
 @queue_name="default",
 @successfully_enqueued=true,
 @timezone="UTC">
irb(main):002:0> Performing TestJob (Job ID: b6741ea0-ff35-48e8-aa57-0cd27fa48ef3) from Async(default) enqueued at 2023-07-28T07:49:52Z
Running test job - Loftwah was here
Performed TestJob (Job ID: b6741ea0-ff35-48e8-aa57-0cd27fa48ef3) from Async(default) in 6.96ms

You can also access the resque logs with:

docker compose logs resque

The response should look like this:

resque_1  | Pipelining commands on a Redis instance is deprecated and will be removed in Redis 5.0.0.
resque_1  | 
resque_1  | redis.pipelined do
resque_1  |   redis.get("key")
resque_1  | end
resque_1  | 
resque_1  | should be replaced by
resque_1  | 
resque_1  | redis.pipelined do |pipeline|
resque_1  |   pipeline.get("key")
resque_1  | end
resque_1  | 
resque_1  | (called from /usr/local/bundle/gems/redis-namespace-1.11.0/lib/redis/namespace.rb:564:in `wrapped_send'}
resque_1  | Redis#sadd will always return an Integer in Redis 5.0.0. Use Redis#sadd? instead.(called from: /usr/local/bundle/gems/redis-namespace-1.11.0/lib/redis/namespace.rb:564:in `wrapped_send')
resque_1  | Running test job - Loftwah was here
resque_1  | Pipelining commands on a Redis instance is deprecated and will be removed in Redis 5.0.0.
resque_1  | 
resque_1  | redis.pipelined do
resque_1  |   redis.get("key")
resque_1  | end
resque_1  | 
resque_1  | should be replaced by
resque_1  | 
resque_1  | redis.pipelined do |pipeline|
resque_1  |   pipeline.get("key")
resque_1  | end
resque_1  | 
resque_1  | (called from /usr/local/bundle/gems/redis-namespace-1.11.0/lib/redis/namespace.rb:564:in `wrapped_send'}

To do

This is what I need to do from here.

I get this warning from resque I need to figure out.

resque_1            | Running test job - Loftwah was here
resque_1            | Pipelining commands on a Redis instance is deprecated and will be removed in Redis 5.0.0.
resque_1            | 
resque_1            | redis.pipelined do
resque_1            |   redis.get("key")
resque_1            | end
resque_1            | 
resque_1            | should be replaced by
resque_1            | 
resque_1            | redis.pipelined do |pipeline|
resque_1            |   pipeline.get("key")
resque_1            | end
resque_1            | 
resque_1            | (called from /usr/local/bundle/gems/redis-namespace-1.11.0/lib/redis/namespace.rb:564:in `wrapped_send'}

Admin user

To create an admin user, run the following command:

docker compose exec web rails console
AdminUser.create!(email: '[e-mail]', password: 'password', password_confirmation: 'password')
docker compose exec web rails generate active_admin:resource User

Compile Sass

To compile Sass, run the following command:

docker compose exec web rails css:install:sass