{"id":15512242,"url":"https://github.com/dxw/rails-template","last_synced_at":"2025-04-24T00:08:57.227Z","repository":{"id":35129550,"uuid":"191957033","full_name":"dxw/rails-template","owner":"dxw","description":"A template repository for use when starting a new app with Rails. It includes dxw default project configuration and decision records.","archived":false,"fork":false,"pushed_at":"2025-04-23T20:46:12.000Z","size":1404,"stargazers_count":12,"open_issues_count":5,"forks_count":4,"subscribers_count":17,"default_branch":"develop","last_synced_at":"2025-04-24T00:08:49.809Z","etag":null,"topics":["delivery-plus","internal","rails","template"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dxw.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"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}},"created_at":"2019-06-14T14:29:31.000Z","updated_at":"2025-04-21T13:10:09.000Z","dependencies_parsed_at":"2023-02-14T07:01:08.769Z","dependency_job_id":"ec828441-5ab4-40ba-9c45-34d88c5be555","html_url":"https://github.com/dxw/rails-template","commit_stats":null,"previous_names":[],"tags_count":1,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dxw%2Frails-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dxw%2Frails-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dxw%2Frails-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dxw%2Frails-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dxw","download_url":"https://codeload.github.com/dxw/rails-template/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250535099,"owners_count":21446508,"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":["delivery-plus","internal","rails","template"],"created_at":"2024-10-02T09:53:32.704Z","updated_at":"2025-04-24T00:08:57.185Z","avatar_url":"https://github.com/dxw.png","language":"Ruby","funding_links":[],"categories":["Ruby"],"sub_categories":[],"readme":"# Using this template\n\n1. Search for `TODO` across the repository to customise the template to the new\n   project\n1. Find and replace `rails-template` across the repository\n1. Be aware of [dxw RFCs](https://github.com/dxw/tech-team-rfcs), especially\n   those that have not resulted in a default code change in this repository:\n   - [rfc-013-use-docker-to-deploy-and-run-applications-in-containers](https://github.com/dxw/tech-team-rfcs/blob/master/rfc-013-use-docker-to-deploy-and-run-applications-in-containers.md)\n\n## Maintaining the template\n\nWe want to keep the template as current as we can, where possible minor and\npatch dependency updates should be merged without seeking approval from three\nmembers of the development team, however they must still be reviewed and the\ntests must pass before merging.\n\nUse best judgement for major updates, if in doubt, look for those three\napprovals.\n\nDevelopers with the correct permissions can override the three approvals merging\nrestriction per dependency.\n\nAny other changes must be discussed in the open and receive the three approvals\nas is usual.\n\nTODO: Remove this section from the README once complete\n\n---\n\n# Rails Template\n\nTODO: replace README header with project name\n\nTODO: Add a summary of who the application is for and what it will do.\n\n1. [Getting started](/doc/getting-started.md)\n\n## Static code analysis\n\nRun [Brakeman](https://brakemanscanner.org/) to highlight any security\nvulnerabilities:\n\n```bash\n$ brakeman\n```\n\nTo pipe the results to a file:\n\n```bash\n$ brakeman -o report.text\n```\n\n## Making changes\n\nWhen making a change, update the [changelog](CHANGELOG.md) using the\n[Keep a Changelog 1.0.0](https://keepachangelog.com/en/1.0.0/) format. Pull\nrequests should not be merged before any relevant updates are made.\n\n## Releasing changes\n\nWhen making a new release, update the [changelog](CHANGELOG.md) in the release\npull request.\n\n## Architecture decision records\n\nWe use ADRs to document architectural decisions that we make. They can be found\nin doc/architecture/decisions and contributed to with the\n[adr-tools](https://github.com/npryce/adr-tools).\n\n## Managing environment variables\n\nWe use [Dotenv](https://github.com/bkeepers/dotenv) to manage our environment\nvariables locally.\n\nThe repository will include safe defaults for development in `/.env.example` and\nfor test in `/.env.test`. We use 'example' instead of 'development' (from the\nDotenv docs) to be consistent with current dxw conventions and to make it more\nexplicit that these values are not to be committed.\n\nTo manage sensitive environment variables:\n\n1. Add the new key and safe default value to the `/.env.example` file eg.\n   `ROLLBAR_TOKEN=ROLLBAR_TOKEN`\n1. Add the new key and real value to your local `/.env.development.local` file,\n   which should never be checked into Git. This file will look something like\n   `ROLLBAR_TOKEN=123456789`\n\n## Access\n\nTODO: Where can people find the service and the different environments?\n\n## Source\n\nThis repository was bootstrapped from\n[dxw's `rails-template`](https://github.com/dxw/rails-template).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdxw%2Frails-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdxw%2Frails-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdxw%2Frails-template/lists"}