https://github.com/a11ywatch/pagemind

A11yWatch Lite gRPC web accessibility service
https://github.com/a11ywatch/pagemind

a11ywatch accessibility grpc

Last synced: 3 months ago
JSON representation

A11yWatch Lite gRPC web accessibility service

• Host: GitHub
• URL: https://github.com/a11ywatch/pagemind
• Owner: a11ywatch
• License: mit
• Created: 2021-03-30T20:41:25.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-12T22:20:05.000Z (8 months ago)
• Last Synced: 2024-09-20T01:40:29.229Z (4 months ago)
• Topics: a11ywatch, accessibility, grpc
• Language: TypeScript
• Homepage: https://a11ywatch.com/website-accessibility-checker
• Size: 1.43 MB
• Stars: 3
• Watchers: 4
• Forks: 1
• Open Issues: 26
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# pagemind

gRPC API for accessibility insights and metrics

## Getting Started

For more information checkout [pagemind](https://a11ywatch.github.io/docs/documentation/pagemind)

## Installation

```

npm install

```

## Start

```

npm run dev

```

## ENV

Add a http/https load balancer url using the env `CHROME_LB` or `FIREFOX_LB` to enable high performance load balancing.

In order to enable firefox use the `FIREFOX_ENABLED` env var. You also need to run `PUPPETEER_PRODUCT=firefox npm i` to download puppeteer if you are running locally.

```

AI_DISABLED=false

CHROME_LB=

FIREFOX_ENABLED=false

PAGEMIND_RECORD=true

DEFAULT_RUNNERS=htmlcs

```

You can set `DEFAULT_RUNNERS` to a comma seperated list with the values of `axe` and `htmlcs`.

## Healthcheck

You can generate a health check client by running `cargo build`. It requires that you first installed the app via `npm i`.

## LICENSE

check the license file in the root of the project.