Kickstart

There are a collection of application templates, scripts, and automatizations I use for everyday work. All included code is written with the following principles:

• Code is testable
• Code is written to be supported without a hassle
• Code is written, following best practices from developers and product communities

Feel free to submit any feature or pull request if you think that it may be useful for the community.

Usage instructions

Quick Start (Recommended)

Create a new Rails application using the interactive installer:

# Interactive mode - select template from menu
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/alec-c4/kickstart/master/install.sh)" -- myapp

# Specify template directly
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/alec-c4/kickstart/master/install.sh)" -- myapp esbuild_tailwind

The installer will:

• Prompt you to select a template (if not specified)
• Check for required dependencies (Ruby, Rails, PostgreSQL)
• Create the Rails application with the chosen template
• Set up the development environment

Templates

esbuild_tailwind

• ESBuild + Tailwind CSS + PostgreSQL
• RSpec, Rubocop, Brakeman
• Kamal deployment ready

minimal

• Importmap + Tailwind CSS + PostgreSQL
• RSpec, Rubocop, Brakeman
• Kamal deployment ready

api

• Rails API-only + PostgreSQL
• CORS, RSpec, Rubocop, Brakeman
• Kamal deployment ready

Manual Usage

# ESBuild + Tailwind template
rails new myapp -m https://raw.githubusercontent.com/alec-c4/kickstart/master/esbuild_tailwind.rb --no-rc --skip-test --skip-system-test --database=postgresql --devcontainer --css=tailwind --javascript=esbuild

# Minimal template
rails new myapp -m https://raw.githubusercontent.com/alec-c4/kickstart/master/minimal.rb --no-rc --skip-test --skip-system-test --database=postgresql --devcontainer --css=tailwind

# API template
rails new myapp -m https://raw.githubusercontent.com/alec-c4/kickstart/master/api.rb --no-rc --skip-test --skip-system-test --database=postgresql --devcontainer --api

Setup

cd myapp
bundle install
yarn install  # for esbuild_tailwind only
rails db:create db:migrate
bin/dev      # or rails server

TODO

Add new templates

• GraphQL API
• Inertia.js + Svelte
• Inertia.js + React

Known issues

Not found

Note

Previous versions of kickstart templates can be found here due to complete project rewrite with master repo reboot.

• Monolith ruby on rails application with tailwindcss frontend
• Monolith ruby on rails application with bootstrap frontend
• Rails API application
• Rails basic/plain application

Contributing

For bug fixes, documentation changes, and features:

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

For larger new features: Do everything as above, but first also make contact with the project maintainers to be sure your change fits with the project direction and you won't be wasting effort going in the wrong direction.