https://github.com/a11ywatch/ddev-a11ywatch
A11yWatch ddev addon
https://github.com/a11ywatch/ddev-a11ywatch
a11ywatch ddev ddev-get
Last synced: 9 days ago
JSON representation
A11yWatch ddev addon
- Host: GitHub
- URL: https://github.com/a11ywatch/ddev-a11ywatch
- Owner: a11ywatch
- License: apache-2.0
- Created: 2023-02-02T12:47:09.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T09:33:18.000Z (6 months ago)
- Last Synced: 2025-03-29T10:43:42.215Z (about 1 month ago)
- Topics: a11ywatch, ddev, ddev-get
- Language: Shell
- Homepage: https://a11ywatch.com
- Size: 148 KB
- Stars: 6
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/a11ywatch/ddev-a11ywatch/actions/workflows/tests.yml) 
## What is this?
This repository allows you to quickly install the warp speed accessibility and vast coverage tool [A11yWatch Lite](https://github.com/a11ywatch/a11ywatch) into a [Ddev](https://ddev.readthedocs.io) project using the instructions below.
## Installation
For DDEV v1.23.5 or above run
```sh
ddev add-on get a11ywatch/ddev-a11ywatch
```
For earlier versions of DDEV run
```sh
ddev get a11ywatch/ddev-a11ywatch
```
Afterwards, run `ddev restart`
## Explanation
This A11yWatch recipe for [ddev](https://ddev.readthedocs.io) installs a [`.ddev/docker-compose.a11ywatch-standalone.yaml`](docker-compose.a11ywatch-standalone.yaml) using the [`A11yWatch`](https://hub.docker.com/r/a11ywatch/a11ywatch/tags) stand-alone docker image.
## Interacting with A11yWatch
* The A11ywatch instance will listen on TCP port 3280 (the A11yWatch default) and port 50050 for gRPC.
* Configure your application to access A11ywatch on the host:port `a11ywatch:3280`.
## Additional Resources
* To get detailed infromation on how to interact or commincate with the [A11yWatch API Info](https://a11ywatch.com/api-info) A11yWatch.
* The [A11yWatch CLI](https://github.com/a11ywatch/a11ywatch) is helpful to perform automated task using the gRPC client.
## Todo
1. Add web panel option start using the `a11ywatch/web` image.
**Contributed by [j-mendez](https://github.com/j-mendez)**