https://github.com/guicattani/rails8-api-template-app
A template API app for Rails 8, using Ruby 3.4.4
https://github.com/guicattani/rails8-api-template-app
rails ruby
Last synced: about 1 month ago
JSON representation
A template API app for Rails 8, using Ruby 3.4.4
- Host: GitHub
- URL: https://github.com/guicattani/rails8-api-template-app
- Owner: guicattani
- License: mit
- Created: 2020-11-01T19:43:31.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2026-04-02T08:36:05.000Z (3 months ago)
- Last Synced: 2026-04-11T05:40:59.184Z (3 months ago)
- Topics: rails, ruby
- Language: Ruby
- Homepage:
- Size: 61.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TemplateApp API
A template API Rails 8 project. Yay!
Ruby version: 3.4.4
Checkout [rails8-vite-react-template](https://github.com/guicattani/rails8-vite-react-template) if you want the Vite + React version of this template. :)
## Getting started
1. Environment variables are stored in `.env`. A sample file was provided, run `cp .env.sample .env` to copy to the correct name it so `rails-dotenv` can read them in runtime.
Then do the same for `database.yml` with: `cp config/database.yml.sample config/database.yml`. You need also change the occurrences of `CHANGEME` found in these config files.
2. Replace every occurrence of `TemplateApp` with the app name you want in this format, and replace every occurrence of `template_app` with the same app name in this underline format and case sensitively.
3. Run `bundle exec rails credentials:edit` to create a `master.key`.
### Gems used:
```
database_cleaner
dotenv-rails
pg
rubocop
rspec-rails
simplecov
shoulda-matchers
```
### Database
TemplateApp API uses PostgreSQL. After setting up your PostgreSQL user, create and migrate the database with:
```
bundle exec rails db:create db:migrate
```
### Test suite
To run the test suite, simply run `bundle exec rspec`. Or to have `rspec-watcher` do that for you, use `RAILS_ENV=test bundle exec rake rspec_watcher:watch`
A default test has been setup to do a health check on the installation and it is located at `spec/requests/root_spec.rb`. Remember to remove this test, the route from `config/routes.rb` and the controller from `app/controllers/root_controller.rb` after setting everything up.
## Docker
A simple Dockerfile and Docker Compose file have been created to bootstrap everything neatly.
Be mindful that containers running inside of containers is not recommended, therefore tests shouldn't be run with TestContainers in the Docker environment.
The default exposed port is `3009` on the host machine, change it on Docker Compose if you experience issues.
### Deployment
To deploy to Heroku
`bundle exec rake deploy:staging`
`bundle exec rake deploy:development`
`bundle exec rake deploy:production`