https://github.com/navapbc/template-application-rails
Ruby on Rails with USWDS template, including CI/CD, for teams building web applications
https://github.com/navapbc/template-application-rails
Last synced: 2 months ago
JSON representation
Ruby on Rails with USWDS template, including CI/CD, for teams building web applications
- Host: GitHub
- URL: https://github.com/navapbc/template-application-rails
- Owner: navapbc
- License: apache-2.0
- Created: 2024-04-01T22:41:01.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2026-04-28T00:57:37.000Z (2 months ago)
- Last Synced: 2026-04-28T01:25:07.952Z (2 months ago)
- Language: Ruby
- Size: 521 KB
- Stars: 5
- Watchers: 24
- Forks: 4
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
Open source tools for every layer of government service delivery.
Strata is a gold-standard target architecture and suite of open-source tools that gives government agencies everything they need to run a modern service.
# Template Ruby on Rails application
This is a template repository for a Ruby on Rails application.
See [`navapbc/platform`](https://github.com/navapbc/strata) for other template repos.
## Features
- [U.S. Web Design System (USWDS)](https://designsystem.digital.gov/) for themeable styling and a set of common components
- Custom USWDS form builder
- Integration with AWS services, including:
- Database integration with AWS RDS Postgresql using UUIDs
- Active Storage configuration with AWS S3
- Action Mailer configuration with AWS SES
- Authentication with [devise](https://github.com/heartcombo/devise) and AWS Cognito
- Internationalization (i18n)
- Authorization using [pundit](https://github.com/varvet/pundit)
- Linting and code formatting using [rubocop](https://rubocop.org/)
- Testing using [rspec](https://rspec.info)
## Repo structure
```text
.
├── template # The template (the things that get installed/updated)
│ ├── .github # GitHub workflows
│ ├── docs # Project docs and decision records
│ └── {{app_name}} # Application code
└── template-only-docs # Template repo docs
```
## Installation
To get started using the template application on your project, for an
application to be called ``:
1. [Install the nava-platform tool](https://github.com/navapbc/platform-cli).
2. Install template by running in your project's root:
```sh
nava-platform app install --template-uri https://github.com/navapbc/template-application-rails .
```
3. Follow the steps in `/README.md` to set up the application locally.
4. Optional, if using the Platform infrastructure template: [Follow the steps in the `template-infra` README](https://github.com/navapbc/template-infra#installation) to set up the various pieces of your infrastructure.
## Updates
If you have previously installed this template and would like to update your
project to use a newer version of this template:
1. [Install the nava-platform tool](https://github.com/navapbc/platform-cli).
2. Update app template by running in your project's root:
```sh
nava-platform app update .
```
## License
This project is licensed under the Apache 2.0 License. See the [LICENSE](LICENSE) file for details.
## Community
- [Code of Conduct](CODE_OF_CONDUCT.md)
- [Contributing Guidelines](CONTRIBUTING.md)
- [Security Policy](SECURITY.md)