Rails REST API boilerplate for typical project
- Features
- Quick run
- Comfortable development
- Links
- Automatic update of dependencies
- Database utils
- Tests
- Database (activerecord).
- Seeding.
- Config Service (rails/config).
- Mailing (activemail).
- Sign in and sign up via email.
- Social sign in (Apple, Facebook, Google, Twitter).
- Admin and User roles.
- I18N (rails-i18n).
- File uploads. Support local and Amazon S3 drivers.
- Swagger.
- E2E and units tests.
- Docker.
- CI (Github Actions).
git clone --depth 1 [email protected]:maearon/rails-boilerplate.git my-app
cd my-app/
cp env-example .env
docker compose up -dFor check status run
docker compose logsgit clone --depth 1 https://github.com/brocoders/nestjs-boilerplate.git my-app
cd my-app/
cp env-example .envChange DATABASE_HOST=postgres to DATABASE_HOST=localhost
Change MAIL_HOST=maildev to MAIL_HOST=localhost
Run additional container:
docker compose up -d postgres redisbundle
rails db:migrate
rails db:seed
rails s- Routes: http://localhost:3000/rails/info/routes
- Adminer (client for DB): http://127.0.0.1/pgadmin4/browser/
- Maildev: http://localhost:3000/letter_opener
If you want to automatically update dependencies, you can connect Depfu for your project.
Generate migration
rails generate migration CreateNameTable Run migration
rails db:migrateRevert migration
rails db:migrate:resetDrop all tables in database
rails db:dropRun seed
rails db:seed# unit tests
rails t
# e2e tests
./node_modules/.bin/cypress rundocker compose -f docker-compose.ci.yaml --env-file env-example -p ci up --build --exit-code-from api && docker compose -p ci rm -svfdocker run --rm jordi/ab -n 100 -c 100 -T application/json -H "Authorization: Bearer USER_TOKEN" -v 2 http://<server_ip>:3000/api/v1/users
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent