Skip to content

Latest commit

 

History

History
55 lines (39 loc) · 1.55 KB

README.md

File metadata and controls

55 lines (39 loc) · 1.55 KB
Raw

18F approaches

A work in progress repository for consolidating the 18F Guides and Methods

Development

Docker

  1. Clone this repo
  2. Run docker compose up
  3. Open http://localhost:8080

Not Docker

To run the site locally:

  1. Clone this repo
  2. Run npm install
  3. From the repo directory, run: 
    npm install
npm run dev
  4. Open http://localhost:8080

Accessiblity Scanning

We use pa11y-ci is used to scan for accessibility issues. The scan runs as part of our CI setup (see the pull-request.yml workflow) on every pull request, but it can also be run locally. To run locally, type:

npm run test:pa11y-ci

Note that running pa11y-ci inside the docker container may not always work.

Contributing

If you are interested in contributing to this repository, you can read more at CONTRIBUTING.

Replatforming

Documentation on the replatforming effort can be found in /docs/replatforming.md

Public domain

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