This is a template repository for a Ruby on Rails application.
See navapbc/platform
for other template repos.
├── .github # GitHub workflows and repo templates
├── docs # Project docs and decision records
├── app-rails # Web application
├── template-only-bin # Scripts for managing this template; not copied into your project
├── template-only-docs # Documentation for this template; not copied into your project
To get started using the template application on your project:
Run the download and install script in your project's root directory.
curl https://raw.githubusercontent.com/navapbc/template-application-rails/main/template-only-bin/download-and-install-template | bash -s
This script will:
You can optionally pass in a branch, commit hash, or release that you want to install. For example:
curl https://raw.githubusercontent.com/navapbc/template-application-rails/main/template-only-bin/download-and-install-template | bash -s -- <commit_hash>
app-rails/README.md
to set up the application locally.template-infra
README to set up the various pieces of your infrastructure.If you have previously installed this template and would like to update your project to use a newer version of this application:
Run the update script in your project's root directory and pass in the branch, commit hash, or release that you want to update to, followed by the name of your application directory (e.g. app-rails
).
curl https://raw.githubusercontent.com/navapbc/template-application-rails/main/template-only-bin/update-template | bash -s -- <commit_hash> <app_name>
This script will:
⚠️ Warning! This will modify existing files. Review all changes carefully after executing the script by running git diff
.