This is a skeleton app for writing APIs.
This skeleton allows you to achieve zen with Rails.
| 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
- Scans gems and docker images for vulnerabilities on every push
- No more sprockets!
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
You can also run the dev stack with Heighliner. It starts Postgres, Redis and the app, as set up in Heighliner.config.
Set it up once:
heighliner init rails-zen
Then start everything:
heighliner up -av # Build and start, with app/ config/ db/ lib/ spec/ mounted
-a mounts your source into the container, so edits show up right away. It stays in the foreground until you press control+c. If you change the Gemfile or Dockerfile, run heighliner up again to rebuild.
Your app is at http://rails-zen.<suffix>, and the swagger login is the same as below.
heighliner show http-suffix # Print the <suffix> for your machine
Other useful commands
heighliner logs # Watch the app logs
heighliner login bundle exec rspec # Run tests
heighliner login sh # Shell into the app container
heighliner db_reset # Put the database back to freshly seeded
heighliner db_save my-snapshot # Save the database
heighliner db_load my-snapshot # Load it back
Snapshots are kept per git branch.
heighliner down stops everything and deletes the database. To restart, just run heighliner up again. Take a db_save first if you have data you care about.
These are ENV vars you can pass to your server when you start up the server that set up its behavior.
Sets up the allowed origin of the frontend, such as 'example.com'
View your API at http://localhost:3000/swagger
user: admin@example.com
pass: asdasd
Comes with PGAdmin at http://localhost:5050.
user: admin@example.com
pass: admin
Rails Zen also runs inside a single container where redis and postgres also run.
docker-compose -f docker-compose.unit.yml up -d # Start
Circle CI scans for known vulnerabilities on every push. None of these need an account.
The image scanners fail on HIGH or CRITICAL issues that have a fix available.
Scanner versions are pinned in .circleci/config.yml with a SHA-256 checksum. When bumping, pick a release that has been out for at least a week and update the checksum too.
If trivy flags something that does not apply, add it to .trivyignore.yaml with a comment saying why.
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