Rails Zen

This is a skeleton app for writing APIs.

This skeleton allows you to achieve zen with Rails.

Features

	Feature
	Comes with default Gitlab CI Configuration
	Comes with default Circle CI Configuration
	Comes with default Github Actions Configuration
	Constantly updates dependencies

• Uses Grape API
• Provides Swagger UI for viewing your API
• Has Papertrail
• IDs default to ULIDs
• Comes with Redis
• Comes with Sidekiq
• Comes with a nice docker compose that sets up a dev environment that you can use immediately
• Devise for swagger and sidekiq dashboards (and everything else you want)
• Pre-prepared browser test suite
• No more sprockets!

Getting Started

Rails Zen comes with a set of useful bash scripts for happy debugging

bin/start              # Start the dev stack

bin/stop               # Shutdown the dev stack

bin/close              # Stop the devstack and delete everything

bin/test               # Run tests

bin/watch              # Watch the logs

bin/attach             # Attach to rails for debugging with binding.pry

bin/shell              # Shell into the rails container

Important ENV Vars

These are ENV vars you can pass to your server when you start up the server that set up its behavior.

FRONTEND_HOST

Sets up the allowed origin of the frontend, such as 'example.com'

Where's my API at

View your API at http://localhost:3000/swagger

user: admin@example.com
pass: asdasd

How to edit database

Comes with PGAdmin at http://localhost:5050.

user: admin@example.com
pass: admin

Unit container

Rails Zen also runs inside a single container where redis and postgres also run.

docker-compose -f docker-compose.unit.yml up -d # Start

My project is not called Rails Zen

There is a script that renames your application and database classes called bin/rename

Simply use that script to rename your project to whatever you like!

bin/rename hello_trains