- Ruby 59.8%
- HTML 37.2%
- Shell 1.4%
- JavaScript 0.9%
- Dockerfile 0.4%
- Other 0.3%
| app | ||
| bin | ||
| build | ||
| config | ||
| db | ||
| docs | ||
| lib/scripts | ||
| public | ||
| test | ||
| .dockerignore | ||
| .gitignore | ||
| AGENTS.md | ||
| ci.yml | ||
| compose-dev-postgresql.yaml | ||
| compose-dev-sqlite3.yaml | ||
| compose-staging.yaml | ||
| CONTRIBUTING.md | ||
| Dockerfile | ||
| gitignore | ||
| LICENSE | ||
| README.md | ||
🚀 Starterkit-8
Welcome to the Starter Kit, a Ruby on Rails template designed to accelerate the launch of new Rails 8 projects using Docker containers, incorporating best practices and modern technologies.
✨ Features
🔒 Security
- Authentication + email validation
- Protection shield (IP Banner, Country banner)
- Audit Logger
- User Preferences
- Administrator Dashboard
- Captchas
💼 For your business
- Responsive Website including dark mode
- Contact Forms
- Blog
- About us
- FAQ Section
- Testimonials in responsive mode
- Localization Map
- Internationalization (I18n)
- SEO Optimizations
- Visitor metrics
- Privacy Policy Template
- Users Management
- Newsletter subscriptions
👤 Miscellaneous
- Gravatar integration
- Uptime statistics widget
🛠 Technical Stack
| Technology | Version/Details |
|---|---|
| Rails | 8.1.3 |
| Ruby | 3.3.10 |
| Tailwindcss | 4.3.1 |
| DaisyUI | 5.5.23 |
| Docker | Docker & Docker Compose |
| Web Server | Puma 8.0.2 |
| Database | PostgreSQL 17.6 + SQLite 3.46.x |
Note
Ensure having those installed on your development environment
🚀 Getting Started
Introduction
Once the setup script is executed, a brand-new project folder will be created. To ensure consistency across multiple development environments, the project is containerized using Docker and Docker Compose.
By default, the following containers will be created:
- {APP_NAME}-rails-app: Debian-based container with Ruby preconfigured.
- {APP_NAME}-rails-db: Container running PostgreSQL database.
Project Initialization
Generate new project code
In this example, we'll create a new project called shopify.
Warning
Choose already now the required database adapter:
sqlite3orpostgresql.
rails new \
--database=postgresql \
--skip-docker \
--skip-action-cable \
--skip-kamal \
--skip-thruster \
--skip-ci \
--template "https://repo.as-consult.io/as-consult/rails-8-template/raw/branch/main/build/template.rb" \
shopify
Create Git Repository
👉 Manually create remote repository (as-consult/shopify)
👉 Commit and Upstream project to remote repository:
git remote add origin ssh://git@repo.as-consult.io:9022/as-consult/shopify.git
git push -u origin main
README
👉 Check new project's README.md for futher explanation!