Rails API Base

Lightweight base or "skeleton" application for Ruby on Rails 5+ projects. Built to minimize the time spent writing boilerplate code and performing repetitive setup tasks.

API docs

• Existing API docs (includes API auth with JWT token)

Application Gems

• Knock for user's auth.
• Rack-Cors support for Cross-Origin Resource Sharing.
• Fast JSON API for objects serialization.
• Restful::Jsonapi for objects deserialization.
• Interactors encapsulates application's business logic
• Puma as Rails web server
• Foreman to manage Procfile-based application
• Rubocop and Rubocop-Rspec for reporting violations of the Ruby style guide
• Pry Rails for interactively exploring objects
• Spring for fast Rails actions via pre-loading
• Factory Girl for test data
• RSpec for unit testing

Scripts

• bin/setup - setup required gems and migrate db if needed
• bin/ci - should be used in the CI or locally. Includes rubocop & specs running.
• bin/server - to run server locally

Deployment

Heroku

Out of the box Rails Api Base ready to be deployed to Heroku.com.

• Heroku Postgres add-on will be used for database.

heroku create --addons=heroku-postgresql --remote staging rails-api-base-example
heroku config:add HOST="rails-base-example.herokuapp.com"
git push staging master
heroku run rake db:schema:load
heroku open

Credits

Rails Api Base is maintained by Damir Nurgaliev.