https://github.com/alec-c4/kickstart
Ruby on Rails application templates
https://github.com/alec-c4/kickstart
bootstrap css nextjs rails ruby ruby-on-rails rubyonrails svelte sveltekit tailwind tailwindcss template templates
Last synced: 3 months ago
JSON representation
Ruby on Rails application templates
- Host: GitHub
- URL: https://github.com/alec-c4/kickstart
- Owner: alec-c4
- License: mit
- Created: 2020-10-30T11:41:26.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-07-28T21:35:04.000Z (over 3 years ago)
- Last Synced: 2025-01-20T21:05:46.799Z (11 months ago)
- Topics: bootstrap, css, nextjs, rails, ruby, ruby-on-rails, rubyonrails, svelte, sveltekit, tailwind, tailwindcss, template, templates
- Language: Makefile
- Homepage: https://alec-c4.com
- Size: 202 KB
- Stars: 70
- Watchers: 4
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 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:
```bash
# 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
### importmap_tailwind
- Importmap + Tailwind CSS + PostgreSQL
- RSpec, Rubocop, Brakeman
- Kamal deployment ready
### api
- Rails API-only + PostgreSQL
- CORS, RSpec, Rubocop, Brakeman
- Kamal deployment ready
## Manual Usage
```bash
# 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
# Importmap + Tailwind template
rails new myapp -m https://raw.githubusercontent.com/alec-c4/kickstart/master/importmap_tailwind.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
```bash
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](https://github.com/alec-c4/ks-rails-tailwind)
- [Monolith ruby on rails application with bootstrap frontend](https://github.com/alec-c4/ks-rails-bootstrap)
- [Rails API application](https://github.com/alec-c4/ks-rails-api)
- [Rails basic/plain application](https://github.com/alec-c4/ks-rails-basic)
## Contributing [](https://github.com/alec-c4/kickstart/issues)
For bug fixes, documentation changes, and features:
1. [Fork it](./fork)
1. Create your feature branch (`git checkout -b my-new-feature`)
1. Commit your changes (`git commit -am 'Add some feature'`)
1. Push to the branch (`git push origin my-new-feature`)
1. 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.