https://github.com/the-teacher/rails-start
Start Rails in one command
https://github.com/the-teacher/rails-start
docker docker-compose elasticsearch pgsql rails redis ruby sanitize sanitizer sidekiq sphinx whenever
Last synced: 29 days ago
JSON representation
Start Rails in one command
- Host: GitHub
- URL: https://github.com/the-teacher/rails-start
- Owner: the-teacher
- License: mit
- Created: 2023-01-05T21:33:17.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2025-10-03T12:39:21.000Z (about 1 month ago)
- Last Synced: 2025-10-03T13:12:22.098Z (about 1 month ago)
- Topics: docker, docker-compose, elasticsearch, pgsql, rails, redis, ruby, sanitize, sanitizer, sidekiq, sphinx, whenever
- Language: Makefile
- Homepage: https://github.com/the-teacher/rails-start
- Size: 13.6 MB
- Stars: 578
- Watchers: 22
- Forks: 78
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Rails Start!
"Rails Start" is a starter kit for Ruby on Rails applications, designed to help developers quickly set up a new project with essential features and best practices.
This project is a perfect choice for:
- **Enterprises** looking to standardize their Rails application setup.
- **Freelancers and agencies** to kickstart client projects.
- **Online education platforms** to start teaching Ruby on Rails.
- **Individual developers** who want a solid foundation for their Rails applications.
## Requirements
- `Docker` and `Docker Compose` installed on your machine.
- `git` installed (usually comes pre-installed on MacOS and Linux).
- `make` utility installed (usually comes pre-installed on MacOS and Linux).
- `WSL2` (For Windows users) with a Linux distribution (like Ubuntu) is recommended.
## How to Use
🪟 Windows Requirements (Click to expand)
### Prerequisites for Windows Users
Before proceeding, Windows users need to set up WSL2:
1. **Install WSL2 and Ubuntu** (if not installed yet):
Open `cmd` or `PowerShell` and run:
```powershell
wsl --install
wsl --set-default-version 2
wsl --install -d Ubuntu
```
2. **Install make utility**:
Run `WSL` and install `make`:
```bash
wsl
sudo apt-get install -y make
```
3. **Continue with the installation steps below** inside your WSL2 Ubuntu terminal.
### Installation Steps
1. Clone the repository:
```bash
git clone https://github.com/the-teacher/rails-start.git
```
2. Navigate to the project directory:
```bash
cd rails-start
```
3. Start the application:
```bash
make rails-start
```
That's it! Very simple!
Now visit: `http://localhost:3000` in your browser.
## The Idea
- `Docker` and `Docker Compose` for easy environment setup.
- `Makefiles` to simplify commands and automate tasks.
- `DevContainer` to make development environment consistent and easy to work with.
- `make rails-start` the only command you need to start your project.
# License
[MIT License. 2023-2025. Ilya N. Zykin](./LICENSE.md)