Rails_api_base

Overview:

The Rails API Base is a boilerplate project for JSON RESTful APIs that follows community best practices in terms of standards, security, and maintainability. It is built on Rails 7.0 and Ruby 3.2. The template includes various features such as user authentication, administration panel, feature flag support, RSpec tests, code quality tools, API documentation, and Docker support. It also provides dev scripts to enhance the development experience.

Features:

• Schema: The project includes a pre-defined schema with tables for users and admin users.
• User Authentication: Users can sign up using their credentials, sign in, sign out, and reset their password. They can also access and update their user profile.
• Administration Panel: The template includes an administration console powered by ActiveAdmin for easy management of users.
• Feature Flag Support: The project includes a UI for managing feature flags, allowing developers to enable or disable certain features.
• RSpec Tests: The template includes RSpec tests to ensure the quality and functionality of the API.
• Code Quality Tools: The project integrates code quality tools such as Code Climate and Test Coverage to maintain code standards and ensure test coverage.
• API Documentation: The API follows the OpenAPI standard and includes API documentation generated using the RSpec API Doc Generator.
• Docker Support: The template provides support for running the project in a Docker container, making it easy to set up and deploy.

Summary:

The Rails API Base template is a comprehensive boilerplate project for building JSON RESTful APIs. It provides a solid foundation for developing APIs following best practices, including security, testing, and code quality. With features like user authentication, administration panel, feature flag support, and Docker integration, developers can quickly start building robust and maintainable APIs.