marian13 / blueprinter

Blueprinter

An app to generate apps.

Quick Links

Description	Link
Local Blueprinter app	http://localhost:9000

Development

Prerequisites

Please, analyze the list of the development dependencies below.

Most of them are not mandatory, but their configurations are committed directly to this repo.

If you prefer to utilize any alternatives, feel free to do it, but the following commands in this README assume their usage.

So it is up to you to translate them to the tool of your choice.

• macOS.

• Homebrew.

• tmux.

• Tmuxinator.

• asdf.

• direnv.

• Docker.

• Task.

• VS Code.

• Google Chrome.

Environment

Copy and run the command below:

cd ~/Projects/blueprinter && task tmuxinator:start

This will start the project for you.

Have a look at .dev/tmuxinator.yml if you are interested in what is happening under the hood.

Once you finish development, use task tmuxinator:stop to turn off the environment.

FAQ

What was the Rails new command?

$ ruby -v
ruby 3.3.0 (2023-12-25 revision 5124f9ac75) [x86_64-darwin22]

$ bundler -v
Bundler version 2.5.7

$ rails -v
Rails 7.1.3.2

$ rails new blueprinter --database=postgresql

Tech Stack

Backend

• Rails.

Service Objects

• Convenient Service.

I18n

• Ruby I18n.

Frontend

• Turbo.

• Stimulus.

CSS Toolkits

• Pico.

HTTP Requests

• Axios.

Websockets

• Action Cable.

Query Params

• query-string.

Toasts

• siiimple-toast.

Utilities

• Lodash.

Databases

• Postgres.

• Redis.

Tests

• RSpec.

• Selenium.

• Capybara.

• Turnip.

• TurnipFormatter.

• SuperDiff.

Debugging

• Byebug.

• Byebug syntax highlighting.

• IRB.

• debug.rb.

• Pry.

• Amazing Print.

• Paint.

• Rouge.

Linting

• RuboCop.

• RuboCop Rails.

• RuboCop RSpec.

• RuboCop Performance.

• Standard Ruby.

• standard-rails.

• DbSchemaChecker.

• Annotate (aka AnnotateModels).

• Standard JS.

• Stylelint.

• stylelint-config-standard.

Documenting

• Rails ERD.

Containerization

• Ruby + Node.

• Postgres.

• Selenium with Chrome.

• Redis.

CI

• GitHub Actions.

Production

• TODO: Stand alone Action Cable server.

Contributing

Conventions

• Conventional Commits.

Must Reads

• Write Reliable, Asynchronous Integration Tests With Capybara.

Backlog

• 100% spec coverage.

• Wrap libraries.