{"id":13398073,"url":"https://github.com/18F/continua11y","last_synced_at":"2025-03-14T00:32:57.014Z","repository":{"id":28906178,"uuid":"32431030","full_name":"18F/continua11y","owner":"18F","description":"continuous integration for website accessibility","archived":true,"fork":false,"pushed_at":"2016-10-07T23:13:39.000Z","size":809,"stargazers_count":31,"open_issues_count":6,"forks_count":13,"subscribers_count":76,"default_branch":"release","last_synced_at":"2024-07-31T18:24:51.100Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://continua11y.18f.gov","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/18F.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-03-18T01:36:58.000Z","updated_at":"2023-08-22T21:01:37.000Z","dependencies_parsed_at":"2022-08-03T06:15:38.842Z","dependency_job_id":null,"html_url":"https://github.com/18F/continua11y","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/18F%2Fcontinua11y","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/18F%2Fcontinua11y/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/18F%2Fcontinua11y/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/18F%2Fcontinua11y/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/18F","download_url":"https://codeload.github.com/18F/continua11y/tar.gz/refs/heads/release","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243505204,"owners_count":20301572,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-30T18:02:05.443Z","updated_at":"2025-03-14T00:32:56.455Z","avatar_url":"https://github.com/18F.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# continua11y\n\n[![Accessibility](https://continua11y.18f.gov/18F/continua11y.svg?branch=release)](https://continua11y.18f.gov/18F/continua11y)\n[![Build Status](https://travis-ci.org/18F/continua11y.svg?branch=release)](https://travis-ci.org/18F/continua11y)\n[![Code Climate](https://codeclimate.com/github/18F/continua11y/badges/gpa.svg)](https://codeclimate.com/github/18F/continua11y)\n[![Test Coverage](https://codeclimate.com/github/18F/continua11y/badges/coverage.svg)](https://codeclimate.com/github/18F/continua11y/coverage)\n\nA continuous integration service using [pa11y](https://github.com/nature/pa11y), a web accessibility tool. It provides a script for generating accessibility statistics for all pages on a site, which is designed to run within a testing environment like Travis CI (though it can run anywhere). It then stores the results of scans in a Postgres database and produces a badge with the result that can be used as an image on any website.\n\n## Contributing\n\nSee [CONTRIBUTING](CONTRIBUTING.md) for additional information.\n\n### Branch flow\n\n- Main branch: `release`\n- Development branch: `develop`\n\n## Usage\n\nRun `continua11y.sh` as part of your [Travis CI](https://travis-ci.org/) suite of tests.\n\n1.  Copy [the script](https://continua11y.18f.gov/continua11y.sh) to your repo and add `after_script: ./path/to/continua11y.sh` to your `.travis.yml` file.\n\n2.  Set a few [environmental variables](http://docs.travis-ci.com/user/environment-variables/#Global-Variables):\n\n    - RUN_SCRIPT: The command for serving your site. Necessary if the server shuts down after the tests run in `script`. Make sure that the server detaches so that the script continues to run.\n    - KILL_SCRIPT: The command to stop serving. This is optional, and more useful for local development.\n    - USE_SITEMAP: If your site has a `sitemap.xml` file, set to `true` to use that instead of the spider.\n    - PORT: The port on `localhost` where your served site is found.\n    - STANDARD: The accessibility standard used for testing. Defaults to `WCAG2AAA`, but can also be `Section508`, `WCAG2A`, or `WCAG2AA`.\n    - CONTINUA11Y: The location where `continua11y` is running. The main site is `continua11y.18f.gov`, but you can change this for testing purposes or whatever.\n\n## Installation\n\n    cp .env.sample .env\n    npm install\n    node app.js # or foreman start\n\nYou may run into trouble installing the `gh-badges` package. Check [that project](https://github.com/badges/shields/blob/master/INSTALL.md#requirements) for more in-depth information.\n\n### Docker setup\n\nOptionally, you can use Docker (and docker-compose) to run the server locally. Once you have Docker and docker-compose installed, run:\n\n```\ndocker-compose up\n```\n\nIf you're on a Mac, you can get the IP address of the local server by running `docker-machine ip`.\n\nThen `open http://$(docker-machine ip):3000` (or visit `localhost:3000` if you're on Linux.).\n\n## Public domain\n\nThis project is in the worldwide [public domain](LICENSE.md). As stated in [CONTRIBUTING](CONTRIBUTING.md):\n\n\u003e 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](https://creativecommons.org/publicdomain/zero/1.0/).\n\u003e\n\u003e 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.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F18F%2Fcontinua11y","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F18F%2Fcontinua11y","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F18F%2Fcontinua11y/lists"}