Skip to content
This repository has been archived by the owner on Apr 20, 2023. It is now read-only.

CivicActions/public-sector-a11y

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

A11yWatch + CivicActions Public Sector Accessibility

Proof of concept for large scale, government scans

🐋 A11y K8 Deploy

Overview

Project Goals

  • Define standardized accessibility metrics
  • Regularly report on government web property accessability
  • Open source all work so others can recreate and help the project
  • Spread awareness of accessibility as it relates to government agencies

Inspiration & Resources

To-Do: Move below to /docs folder

Infrastructure

Cloud resources are managed by the .yaml files in the /k8s directory. The namespace public-sector-a11y has been assigned to resources orchestrated from this repo. The metadata.name value in the k8 files defines the sub-domain of the public url.

For example, the a11ywatch-frontend file deploys resources avaliable at a11ywatch-frontend.public-sector-a11y.app.civicactions.net

API

OpenAPI 3.0.9 Schema

API Docs

Schema Docs

JavaScript

APIs
Collection API

Collection API Docs

Method HTTP request Description
getAnalytics GET /list/analytics Get the analytics for a website
getIssues GET /list/issue List the issues for a website
getPageSpeed GET /list/pagespeed Get the pagespeed for a website
getPages GET /list/pages List the pages in order for a website
getWebsites GET /list/website Returns websites for the user in alphabetical order
Reports API

Collection API Docs

Method HTTP request Description
crawlWebsiteStream POST /crawl Multi-page crawl a website streaming issues on found
crawlWebsitesSync POST /websites-sync Multi-page crawl all websites attached to account
getReport GET /report Get the report from a previus scan
scanWebsite POST /scan Scan a website for issues
scanWebsiteSimple POST /scan-simple Scan a website for issues without storing data and limited responses.
User API

User API Docs

Method HTTP request Description
createUser POST /register Register user into the system
getUsers GET /user Get user
loginUser POST /login Logs user into the system
logoutUser POST /logout Logs out current logged in user session
Websites API

Websites API Docs

Method HTTP request Description
addWebsite POST /website Add a website in the collection with form data
deleteWebsite DELETE /website Deletes a website
getWebsiteByDomain GET /website Find website by Domain

Contributing

License

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages