a11ywatch-web

The web application for A11yWatch using Rust, Wasm, and Next.js.

https://user-images.githubusercontent.com/8095978/209417141-c287dbab-5b00-4d2b-b19a-dad013403718.mp4

Installation

Rust is required if you want to build the wasm bundle for the web or the desktop application.

curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf | sh

Install the dev modules normally with yarn.

yarn

Desktop Install

You can also install the desktop application by using tauri and running the following:

Install the tauri-cli with:

cargo install tauri-cli

Start Web or Desktop

You can start the project using docker or local

docker-compose up or yarn run dev

open localhost:3000 in your browser.

or run the desktop application

cargo tauri dev.

API

In order to use the application you need to make sure you have the A11yWatch system running locally. View the compose file to see the micro services used.

Development

Some things to note in development.

Creating Pages

This app uses a meta like way to enhance the build step with auto generated html from the page components. Some of the enhancements require a certain format for Page naming and exports to build the pages correctly. The default export component in the ./pages directory needs to match the route or naming of the file as camel-case.

Environment

Take a look at the Environmental Configuration for configuring project specifics like google authentication.

Translations

At the moment all text is supported for english-en. Help contribute to the translations by sending a PR.

LICENSE

check the license file in the root of the project.