We help people in government build better digital services

https://digital.gov

• Sign-up for the [Digital.gov newsletter »]({{< ref "/about/subscribe.md" >}})
• Follow us on Twitter »
• Like our page on Facebook »

Want to learn more about how we work? Check out our Wiki page »

---

Development Guide

Digital.gov is built with Hugo and hosted by Federalist and Cloud.gov.

Install NPM Dependencies

npm install

Install Hugo

Read the HUGO quickstart guide »

For OSX: brew install hugo see https://gohugo.io/getting-started/installing/ for other OSs

Run

1. Run hugo serve in the terminal
2. wait 5-6 secs
3. visit http://localhost:1313/

Accessibility tests

We follow the WCAG2AA standard, and one of the ways we check that we're following the right rules is through automated tools, like pa11y. For more info on the rules being tested checkout the pa11y wiki.

Running tests

To run a web accessibility test on digital.gov do the following:

1. Check out the site from GitHub https://github.com/GSA/digitalgov.gov/
2. Install and run the site locally following the Install and Run instructions above. Site must be running locally to perform the scan.

• If this is your first time running pa11y, then you'll need to run npm install to make sure pa11ly is installed.

2. In a separate terminal window, run npm run test:pa11y to initiate the accessibility checker.

Note: Currently, this only runs accessiblity checks on the site home page as a Proof of Concept demonstration.

Accessibility testing configuration is located in the .pa11yci file.