README.md

Simple Report Public Website

The static website resources for https://www.simplereport.gov/

Table of Contents

• Simple Report Public Website
  • Table of Contents
  • Recommended Versions
  • Setup
  • Contributing
  • Cloud Environments

Recommended Versions

Software	Version	How to Configure
Node	22.x	Configure with .nvmrc using asdf or nvm
Ruby	3.1.x	Configure with .ruby-version using asdf or rbenv

Setup

Install node packages yarn install

Install bundler gem install bundler

Install gems bundle install

Run Setup yarn setup

Build/Watch sass in separate yarn watch

Serve site yarn serve

Contributing

1. make changes on a branch
2. Open a PR and deploy the branch to a non prod env (staging, test, pentest or github pages). Note this environment will be overridden on merges to main
3. Link to deployed code in PR
4. Ensure all checks are passing, get at least one code review, and that changes work as expected in the cloud env
5. Merge PR into main make sure changes are deployed and working in demo

Cloud Environments

Type	Static Site URL	Deployment	How to trigger
Prod	https://www.simplereport.gov	Automed on merge to main	Github Actions
Staging	https://stg.simplereport.gov	Automed on merge to main	Github Actions
Dev	https://dev.simplereport.gov	Automed on merge to main	Github Actions
Demo	https://demo.simplereport.gov	Automed on merge to main	Github Actions
Test	https://test.simplereport.gov	Automed on merge to main	Github Actions
Pentest	https://pentest.simplereport.gov	Automed on merge to main	Github Actions
Training	https://training.simplereport.gov	Automed on merge to main	Github Actions