Ruby Rails Boilerplate

Overview

The Rails REST API boilerplate is a project designed to provide a starting point for building a typical Rails REST API. It includes a range of features such as database management, seeding, configuration services, mailing functionality, user authentication, social sign-in, role management, internationalization, file uploads, Swagger documentation, testing capabilities, Docker integration, and CI (Continuous Integration) with GitHub Actions.

Features

• Database: The boilerplate utilizes ActiveRecord for managing the database.
• Seeding: Includes functionality for seeding the database.
• Config Service: Provides a configuration service for easier management of project configurations.
• Mailing: Supports mailing functionality using activemail.
• Sign in and sign up: Allows users to sign in and sign up using their email.
• Social sign in: Supports social sign in with popular platforms such as Apple, Facebook, Google, and Twitter.
• Admin and User roles: Implements role management capabilities, distinguishing between admin and user roles.
• I18N: Includes functionality for internationalization using the rails-i18n gem.
• File uploads: Supports file uploads with options for local storage or Amazon S3 drivers.
• Swagger: Integrates the Swagger tool for API documentation.
• E2E and unit tests: Provides testing capabilities with support for end-to-end and unit tests.
• Docker: Offers Docker integration for easier deployment and management of the project.
• CI (GitHub Actions): Includes Continuous Integration capabilities using GitHub Actions for automatic updates and testing.

Installation

To get started with the Rails REST API boilerplate, follow these steps:

1. Change DATABASE_HOST=postgres to DATABASE_HOST=localhost.
2. Change MAIL_HOST=maildev to MAIL_HOST=localhost.
3. Run the additional container.
4. Access the following links:
   • Routes: http://localhost:3000/rails/info/routes
   • Adminer: http://127.0.0.1/pgadmin4/browser/
   • Maildev: http://localhost:3000/letter_opener

To automatically update dependencies, you can connect Depfu to your project. For database management, there are options to generate migrations, run migrations, revert migrations, drop all tables in the database, and run seeds. Testing can be done within Docker, and benchmarking tests are also supported.

Summary

The Rails REST API boilerplate is a comprehensive starting point for building a Rails REST API project. With its extensive list of features and integration with important tools like Docker and GitHub Actions, it provides developers with a comfortable and efficient development experience. Whether you need database management, user authentication, internationalization, file uploads, or testing capabilities, this boilerplate has you covered.