classicvalues/prime-simplereport-site

Landing / marketing site for the SimpleReport application

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
  • E2E Tests
  • Contributing
  • Cloud Environments
  • Manually Trigger Deploy

Recommended Versions

Software	Version	How to Configure
Node	14.x	Configure with .nvmrc using nvm
Ruby	2.6.x	Configure with .ruby-version using 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

E2E Tests

End to end tests are written with Nightwatch.js. Run the tests while the site is being served locally with: yarn e2e

Contributing

1. make changes on a branch
2. Open a PR and deploy 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
6. Manually trigger a deploy of main to prod. See Manually Trigger Deploy

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
github pages	https://cdcgov.github.io/prime-simplereport-site/	Automed on merge to main and gh-pages	yarn deploy

Manually Trigger Deploy

1. Navigate to the Github Actions Tab
2. Select the environment you want to deploy to from the workflows list. In this case we are selecting the dev environment
3. Click the "Run workflow" button, select the branch you want to deploy and click the green "Run workflow" button. In this case we are deploying the latest commit on main to dev
4. 
5. After the workflow is completed you can verify the changes are live by Checking the deployed commit hash. This is done my going to view-source:https://dev.simplereport.gov/ (or the url for the env you deployed to). Note the deployed commit hash will appear in a comment right before the closing body tag.

    <!-- 56799f6 -->
  </body>
</html>

The Azure environments are served behind a CDN and may take some time to update. If you are not seeing an update or are fixing an urgent bug the CDN can be purged via https://docs.microsoft.com/en-us/azure/cdn/cdn-purge-endpoint