https://github.com/a11ywatch/a11ywatch-web-lite

The web accessibility tool that empowers users to stay inclusive. Help us build the next gen of A11yWatch with feedback and getting in on the code. [LiteMode]
https://github.com/a11ywatch/a11ywatch-web-lite

a11ywatch nextjs rust wasm webassembly

Last synced: 2 months ago
JSON representation

The web accessibility tool that empowers users to stay inclusive. Help us build the next gen of A11yWatch with feedback and getting in on the code. [LiteMode]

• Host: GitHub
• URL: https://github.com/a11ywatch/a11ywatch-web-lite
• Owner: a11ywatch
• License: mit
• Created: 2023-02-01T17:31:54.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-06-21T17:06:19.000Z (almost 2 years ago)
• Last Synced: 2025-01-01T09:41:46.600Z (4 months ago)
• Topics: a11ywatch, nextjs, rust, wasm, webassembly
• Language: TypeScript
• Homepage: https://a11ywatch.com
• Size: 34.8 MB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# a11ywatch-web

[![A11yWatch](https://circleci.com/gh/a11ywatch/web.svg?style=svg)](https://circleci.com/gh/a11ywatch/web)

[![codecov](https://codecov.io/gh/a11ywatch/web/branch/main/graph/badge.svg?token=0LZKQ2H848)](https://codecov.io/gh/a11ywatch/web)

The web application for [A11yWatch](https://a11ywatch.com) using [Rust](https://www.rust-lang.org/), [Wasm](https://webassembly.org/), and [Next.js](https://nextjs.org/).

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](https://tauri.app/v1/guides/getting-started/prerequisites) and running the following:

Install the [tauri-cli](https://tauri.app/v1/api/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](http://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](https://github.com/A11yWatch/a11ywatch) system running locally. View the [compose](https://github.com/A11yWatch/a11ywatch/blob/master/docker-compose.yml) 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](https://docs.a11ywatch.com/documentation/web/#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](https://github.com/A11yWatch/web/tree/main/src/content/strings/a11y) by sending a [PR](https://github.com/A11yWatch/web/compare).

## LICENSE

check the license file in the root of the project.