{"id":20060718,"url":"https://github.com/xhostcomweb/rails-7-api-starter","last_synced_at":"2025-09-01T03:05:36.516Z","repository":{"id":127410320,"uuid":"484750434","full_name":"xhostcomweb/rails-7-api-starter","owner":"xhostcomweb","description":" Boost API creation speed and create a fully configured project along with tools to keep your quality high. The project has one module named User which is used to authenticate. \u0026 User Postman collection","archived":false,"fork":false,"pushed_at":"2022-05-02T15:09:07.000Z","size":48,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-12T22:14:46.815Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/xhostcomweb.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}},"created_at":"2022-04-23T13:08:51.000Z","updated_at":"2022-07-09T13:44:05.000Z","dependencies_parsed_at":null,"dependency_job_id":"52ff809f-bf04-423c-be12-d525a3fb356a","html_url":"https://github.com/xhostcomweb/rails-7-api-starter","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xhostcomweb%2Frails-7-api-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xhostcomweb%2Frails-7-api-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xhostcomweb%2Frails-7-api-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xhostcomweb%2Frails-7-api-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xhostcomweb","download_url":"https://codeload.github.com/xhostcomweb/rails-7-api-starter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241488201,"owners_count":19970829,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-11-13T13:16:28.559Z","updated_at":"2025-03-02T10:14:34.274Z","avatar_url":"https://github.com/xhostcomweb.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Rails 7 API Jumpstart\n\nRails Versioned API solution template\n\nWith UUIDs Primary/foreign keys\n\n* Version 3.1.0\n\n## Table of Contents\n\n* [Prerequisites](#prerequisites)\n* [Project Setup](#project-setup)\n* [Development](#development)\n* [GraphQL API playground](#graphql-api-playground)\n* [Tools](#tools)\n* [Pry initializer](#pry-initializer)\n* [Traceroute](#traceroute)\n* [GraphQL Preload gem](#graphql-preload-gem)\n* [Test API with Postman](#test-api-with-postman)\n\n## Prerequisites\n\n* [Ruby](https://www.ruby-lang.org/en/downloads/)\n* [Ruby on Rails](http://guides.rubyonrails.org/getting_started.html)\n* [RVM](https://rvm.io/)\n* [PostgreSQL DB](https://www.postgresql.org/docs/)\n\n## Project Setup\n\n* For production, you need to replace the asterisk with the URL of your client-side application in ./config/initializers/cors.rb file.\n\n1. Clone or download this repo\n2. Run `bundle install`\n3. Run `rake db:create`\n4. Run `bin/rails db:migrate RAILS_ENV=development`\n5. Run `bin/rails db:seed RAILS_ENV=development`\n6. Run `foreman start -f Procfile.dev`\n7. Visit --\u003e [http://localhost:5000/](http://localhost:5000/). That's it!.\n\n## Tools\n\n* Run `rubocop` for Ruby lint.\n* Run `rubocop -a` for fixed some issues automatically.\n* Run `reek .` for analyzing code.\n* Run `brakeman` for static analysis and for security vulnerabilities.\n* Run `rails_best_practices .` in root app directory. Helps to find unused methods, missing indexes into database tables and many other things.\n\n### Annotate (aka AnnotateModels) usage\n\nTo annotate all your models, tests, fixtures, and factories:\n\n```bash\ncd /path/to/app\nannotate\n```\n\nTo annotate just your models, tests, and factories:\n\n```bash\nannotate --exclude fixtures\n```\n\nTo annotate just your models:\n\n```bash\nannotate --exclude tests,fixtures,factories,serializers\n```\n\nTo annotate routes.rb:\n\n```bash\nannotate --routes\n```\n\nTo remove model/test/fixture/factory/serializer annotations:\n\n```bash\nannotate --delete\n```\n\nTo remove routes.rb annotations:\n\n```bash\nannotate --routes --delete\n```\n\nTo automatically annotate every time you run db:migrate, either run rails g annotate:install or add Annotate.load_tasks to your `Rakefile`. See the configuration in Rails section for more info.\n\n### Gitlab CI\n\n* You need configure `.gitlab-ci.yml` file with your Heroku credentials.\n\n### Travis CI\n\n* You need configure `.travis.yml` file with your Travis and Heroku credentials.\n\n## Pry initializer\n\nAvoid repeating yourself, use pry-rails instead of copying the initializer to every rails project.\n\n* Run `rails console` and in Rails console:\n* For showing models --\u003e `show-models`.\n* For showing routes --\u003e `show-routes`.\n\n## Traceroute\n\n* Run `rake traceroute`.\n\n## Test API with Postman\n\n* You can find some examples [here.](./DOCUMENTATION.md) and a postman import file in docs folder\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxhostcomweb%2Frails-7-api-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxhostcomweb%2Frails-7-api-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxhostcomweb%2Frails-7-api-starter/lists"}