Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/a11ywatch/core
A11yWatch API and core Lite
https://github.com/a11ywatch/core
a11ywatch web-accessibility
Last synced: 5 days ago
JSON representation
A11yWatch API and core Lite
- Host: GitHub
- URL: https://github.com/a11ywatch/core
- Owner: a11ywatch
- License: mit
- Created: 2021-03-31T01:08:55.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-01T06:37:18.000Z (12 days ago)
- Last Synced: 2024-11-01T07:24:57.234Z (12 days ago)
- Topics: a11ywatch, web-accessibility
- Language: TypeScript
- Homepage: https://a11ywatch.com/api-info
- Size: 12.6 MB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 313
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# a11ywatch-core
[](https://codeclimate.com/github/A11yWatch/a11ywatch-core/maintainability)
Central API for A11yWatch available in REST, GraphQl, and gRPC.
## Getting Started
To get started you can use docker or run on your local machine following the commands below. In order to run this repo effectively take a look at the docker compose file in the central command repo [compose](https://github.com/A11yWatch/a11ywatch/blob/main/docker-compose.yml).
```sh
docker-compose up
```
or
```sh
npm i
npm run dev
```
## Environmental variables
Project configuration below:
### Emailing
To get the emailer working add the following env variables to the project.
```
[email protected]
EMAIL_CLIENT_ID=
EMAIL_CLIENT_KEY=
```
### JS Scripts
In order to store javascript locally to use you need to enable the following env vars:
```
SCRIPTS_ENABLED=true
A11YWATCH_NO_STORE=false
```
## Cron
Enable CRON morning and nightly jobs
```
A11Y_WATCH_CRON_ENABLED=true
```
### Queue
Set the limit to number of test in parallel per run to `CRAWL_QUEUE_LIMIT` env var - default is set to 8.
If you have kubernetes, docker swarm, or Fargate - you can increase this limit based on your chrome browser count.
## Testing
In order to easily test the application we use [dagger](https://docs.dagger.io/)
```
dagger do build
```
## LICENSE
check the license file in the root of the project.