The static marketing site for Login.gov
- Branching and Publishing Workflow
- Configuring Site Settings
- Contact Form Outages
- Nested Help Articles
- Netlify CMS
This is a Jekyll-built static site. To install dependencies:
make setup
Then, to start serving the site locally in development:
make run
You can then view the site in your browser at http://localhost:4000 .
To get mock data for Post Office Search:
Update identity-idp config/application.yml with:
in_person_public_address_search_enabled: true
Then, start identity-idp server locally:
make run
Next update identity-site _config.yml with:
po_search_locations_search_url: http://xxx.x.x.x:3000/api/usps_locations
where xxx.x.x.x is the remote IP address in identity-idp
Then, start identity-site server locally:
make run
You can then view the site in your browser at http://localhost:4000/help/verify-your-identity/verify-your-identity-in-person/find-a-participating-post-office/.
To run specs:
make test
To run end-to-end browser tests:
npm test
End-to-end tests include:
- Automated accessibility scan for each page
To check for code formatting or potential syntax errors:
make lint
To run HTMLProofer
make htmlproofer
This project uses Prettier to format code. When running the lint command above, you may notice errors relating to unexpected code formatting. It's recommended that you install an editor integration to automatically format code on save, but you can also resolve these errors automatically from the command-line by running:
npm run lint -- --fix
The lint task will check to see that SVG images are optimized. To optimize images during local development, run:
npm run optimize-assets
See CONTRIBUTING for additional information.
This project is in the worldwide public domain. As stated in CONTRIBUTING:
This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.
All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.