Rails7 StartKit. Launch App in minutes!

Rails 7. Start Kit

Rails 7 App with Preinstalled Tools is Ready in Minutes!

Why?

Usually It is difficult and time consuming to setup a typical Rails environment from scratch.

Since now if you have Ruby and Docker then you have working Rails environment in about 5 minutes without any manual efforts.

What is under the hood?

Logotype	Description	Why it was added
	Docker Containerization for Services	Helps to keep all required services in containers. To have fast and predictable installation process in minutes
	PostgresSQL	Most popular relation database
	Ruby 3.2	Most recent version of Ruby
	Rails 7	Most recent version of Rails
	gem "config"	Configuration management tool
	Elasticsearch	The world’s leading Search engine
	Chewy	Ruby Connector to Elasticsearch
	Redis	In-memory data store. For caching and as a dependency of Sidekiq
	Sidekiq	Job Scheduler and Async Tasks Executor. Can be used as a stand alone tool or as ActiveJob backend
	Import Maps	Rails' recommended way to process JavaScript
	Puma	Application Web Server. To launch Rails app

What I'm going to add...

Logotype	Description	Why it was added
	Kaminari	Pagination solution
	Devise	Authentication solution for Rails
	Devise	Login with Facebook and Google
	Devise and Action Mailer	Sending emails for account confirmations
	Letter Opener	Email previwer for development
	whenever	Linux Cron based periodical tasks
	RSpec	Testing Framework for Rails
	Rubocop	Ruby static code analyzer (a.k.a. linter) and code formatter.

All trademarks, logos and brand names are the property of their respective owners.

Prerequisites

On your host you have:

• Ruby 2+
• Docker
• Git

How to start?

ONE!

git clone https://github.com/the-teacher/rails7-startkit.git

TWO!

cd rails7-startkit

THREE!

bin/setup

You will see something like that:

1. Launching PgSQL container
2. Launching Rails container
3. Installing Gems. Please Wait
4. Create DB. Migrate DB. Create Seeds
5. Launching Redis Container
8. Indexing Article Model
9. Launching Rails App with Puma
10. Launching Sidekiq
11. Visit: http://localhost:3000

Index Page of the Project

bin/ commands

From the root of the project

Conventions and Agreements

For demonstration, education and maintainance purposes I use the following approach:

Data

• All services' data related folders are placed in ./db
• All folders are UPPERCASED

./db
├── ELASTIC
├── PGSQL
└── REDIS

Configuration Files

• All services' configurations are placed in ./config
• All configs are _UNDERSCORED and UPPERCASED

./config
├── _CONFIG.yml
├── _PUMA.rb
├── _SIDEKIQ.yml
└── _THINKING_SPHINX.yml

Initialazers

• All services' initializers are placed in ./config/initializers
• All files are _UNDERSCORED and UPPERCASED

./config/initializers/
├── _CHEWY.rb
├── _CONFIG.rb
├── _REDIS.rb
└── _SIDEKIQ.rb

Rails user

As a user to own files and run Rails inside a container I use

user:group => lucky:lucky => 7777:7777

If you would like to run the project on a linux environment then:

• create group lucky (7777) and user lucky (7777)
• run the project with RUN_AS=7777:7777 option

How to Run Tests

From the root of the project

  bin/open rails

Now you are in the Rails container and you can do everything as usual

  RAILS_ENV=test rake db:create
  rake test

Questions and Answers

TODO

• ElasticSearch. Chewy
• Memcached Link Rejected
• Puma on systemd Link Rejected
• Sidekiq on systemd Link Rejected
• Action Cable Link
• Nginx

License

MIT