{"id":30918817,"url":"https://github.com/guicattani/rails8-api-template-app","last_synced_at":"2026-05-19T07:36:26.961Z","repository":{"id":131391171,"uuid":"309174259","full_name":"guicattani/rails8-api-template-app","owner":"guicattani","description":"A template API app for Rails 8, using Ruby 3.4.4","archived":false,"fork":false,"pushed_at":"2026-04-02T08:36:05.000Z","size":63,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-04-11T05:40:59.184Z","etag":null,"topics":["rails","ruby"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/guicattani.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-11-01T19:43:31.000Z","updated_at":"2026-04-02T08:36:10.000Z","dependencies_parsed_at":null,"dependency_job_id":"f82279aa-cf12-4af0-99a9-0114dfd59627","html_url":"https://github.com/guicattani/rails8-api-template-app","commit_stats":null,"previous_names":["guicattani/rails7-api-template-app"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/guicattani/rails8-api-template-app","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guicattani%2Frails8-api-template-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guicattani%2Frails8-api-template-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guicattani%2Frails8-api-template-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guicattani%2Frails8-api-template-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/guicattani","download_url":"https://codeload.github.com/guicattani/rails8-api-template-app/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guicattani%2Frails8-api-template-app/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33206320,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-19T07:16:55.748Z","status":"ssl_error","status_checked_at":"2026-05-19T07:16:54.366Z","response_time":58,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["rails","ruby"],"created_at":"2025-09-10T00:27:35.406Z","updated_at":"2026-05-19T07:36:26.953Z","avatar_url":"https://github.com/guicattani.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TemplateApp API\nA template API Rails 8 project. Yay!\nRuby version: 3.4.4\n\nCheckout [rails8-vite-react-template](https://github.com/guicattani/rails8-vite-react-template) if you want the Vite + React version of this template. :)\n\n##  Getting started\n1. 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.\nThen 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.\n\n2. 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.\n\n3. Run `bundle exec rails credentials:edit` to create a `master.key`.\n\n### Gems used:\n  ```\n    database_cleaner\n    dotenv-rails\n    pg\n    rubocop\n    rspec-rails\n    simplecov\n    shoulda-matchers\n  ```\n### Database\n  TemplateApp API uses PostgreSQL. After setting up your PostgreSQL user, create and migrate the database with:\n  ```\n  bundle exec rails db:create db:migrate\n  ```\n### Test suite\n  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`\n\n  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.\n\n## Docker\n  A simple Dockerfile and Docker Compose file have been created to bootstrap everything neatly.\n\n  Be mindful that containers running inside of containers is not recommended, therefore tests shouldn't be run with TestContainers in the Docker environment.\n\n  The default exposed port is `3009` on the host machine, change it on Docker Compose if you experience issues.\n\n### Deployment\n  To deploy to Heroku\n  `bundle exec rake deploy:staging`\n  `bundle exec rake deploy:development`\n  `bundle exec rake deploy:production`\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguicattani%2Frails8-api-template-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fguicattani%2Frails8-api-template-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguicattani%2Frails8-api-template-app/lists"}