README.md

Accessibility Toolkit

This is a (soon to be) AI-powered accessibility toolkit for websites. Be able to determine how accessible your website is and receive recommendations on improving it for better equality and accessibility.

Getting started

To get started with this code:

Clone this repository and cd into it:

git clone https://github.com/hassanShakur/accessibility-toolkit.git

cd accessibility-toolkit

Change the directory into the server folder and install the dependencies:

Terminal 1

cd server

npm install

Also, install python dependencies in the same folder:

pip install -r requirements.txt

In a separate terminal, change the directory into the client folder and install the dependencies:

Terminal 2

cd client

npm install

Running the code

To run the code, you need to start the server and the client. To start the server, run this in Terminal 1:

npm run dev

To start the client, run this in Terminal 2:

npm run dev

If all goes well, the app should be running at localhost:3000 ✨.

Sample UI View

Home Page

Sample accessibility report

Note: This is a work in progress. More features will be added soon, including a better UI and more accessibility checks.