tonystrawberry/template.rails.react.openapi

🚀 Ready-to-use Rails7 API/ReactJS/OpenAPI monolithic web application template

Monolithic web application template with Rails & React

🚀 Rails 7 API / ReactJS / OpenAPI - Monolithic Web Application Template

This starter template will help you get started in a new full-stack web application.

💾 Versions

Ruby 3.1.2
Rails 7.0.2
PG 13

React 18.1.0
Typescript 4.6.3

OpenAPI 3.0.3

📋 Features

• Rails API 7 (with Docker integration)
• PostgreSQL local database & settings
• React Frontend (with Docker integration)
• Support for JWT Token Authentication & Authorization
• Support for OAuth2 Authentication
• Client API code generation based on OpenAPI 3.0 schema definition
• Rails-side test implementation (unit & controller)
• SonarCloud property/settings file
• Add annotation gem (make it optional)
• Add parameters validation gem (make it optional)
• Code coverage with SonarCloud
• Add delight to the experience when all tasks are complete 🎉

👨🏻‍💻 Local development

docker-compose build
docker-compose run --rm backend bundle install
docker-compose run --rm backend rails db:create rails db:migrate db:seed 
docker-compose up

docker-compose run --rm frontend npm install
docker-compose run --rm frontend npm run generate-api-client # generate API client code into `src/types/typescript-axios`

🛠 Access Rails console

docker-compose run --rm backend rails c

$ User.all # Fetch and show all users 

❤️ Tests

docker-compose run --rm backend /bin/bash

$ RAILS_ENV=test rspec spec/ # Run all tests inside spec folder

👨🏻‍💻 Install gems

1. Add the gem in the Gemfile.
2. Run docker-compose run --rm backend bundle install

👨🏻‍💻 Local URLs

Frontend: http://localhost:4000. Backend: http://localhost:3000.