{"repo":"rootstrap/rails_api_base","free":true,"listed":false,"github":"https://github.com/rootstrap/rails_api_base","clone":"git clone https://github.com/rootstrap/rails_api_base.git","description":"API boilerplate project for Ruby on Rails 8","language":"Ruby","stars":632,"topics":["ruby","ruby-on-rails","rails-api","boilerplate","api","api-boilerplate","hacktoberfest"],"license":"MIT","category":"saas-starters-boilerplates","readme_excerpt":"Rails API Template Rails API Base is a boilerplate project for JSON RESTful APIs. It follows the community best practices in terms of standards, security and maintainability, integrating a variety of testing and code quality tools. It's based on Rails 8.1 and Ruby 4.0. Finally, it contains a plug an play Administration console (thanks to ActiveAdmin). Features This template comes with: - Schema - Users table - Admin users table - Endpoints - Sign up with user credentials - Sign in with user credentials - Sign out - Reset password - Get and update user profile - Administration panel - Feature flags support with a UI for management - Code quality tools - RSpec tests - RSpec API Doc Generator - API documentation following OpenAPI - Docker support How to use 1. Clone this repo 1. Install PostgreSQL in case you don't have it 1. Install node. The expected node version is defined in .nvmrc file. 1. Install yarn. You can run corepack enable to install the required yarn binaries. Corepack is already included in newest node versions. 1. Run bootstrap.sh with the name of your project like ./bin/bootstrap.sh --name=my awesome project . 1. Run yarn install and yarn build --watch . This bundles the JS assets in the administration site using esbuild. 1. bundle exec rspec and make sure all tests pass (non-headless mode) or HEADLESS=true bundle exec rspec (headless mode) 1. Run bin/dev . 1. You can now try your REST services! How to use with Docker 1. Have docker and docker-compose installed ","default_branch":null,"files":null,"tree":[],"storefront":"/r/rootstrap","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/rootstrap/rails_api_base/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}