Rails API Boilerplate

How to Works?

mermaidCopy
flowchart TD
  R[Request] --> C[Application Controller]
  C --> O[Application Operation]
  O -- Validate Params --> AC[Application Contract]
  O -- Application Contract returned success?--> S[Application Service]
  AC -- Validation success? --> O[Application Operation]
  AC -- Validation failed? --> E[Contract Errors]
  E --> RE
  S -- Process successful? --> RS[Resource]
  S -- Process failed? --> OE[Resource Errors]
  OE --> RE[Response]
  RS --> RE
  RE -- Returns --> C

Documentations

• Swagger
• Service generator
• Contract generator
• Search & Filter & Sort

Installation

Prerequisites

• Ruby
• PostgreSQL
• Redis

Installation

• Install GEM dependencies:

  bashCopy
  bundle install

• Create database, migrate tables and run the seed data:

  bashCopy
  rails db:create
  rails db:migrate
  rails db:seed

• If you are setting up again, when you already have previous databases:

  bashCopy
  rails db:reset

  reset is equivalent of rails db:drop & rails db:setup.

• Run the server

  bashCopy
  ./bin/dev