This tool is used to check if websites comply with the Web Content Accessibility Guidelines (WCAG).
We're using a Miro Board to keep track of the progress and add all requirements and decisions.
The Backend and the Frontend are written in TypeScript and run on Node.js. For better developer experience ESLint and Prettier are used.
- backend/: Contains all server-related files. For more information about the Backend, continue here.
- frontend/: Contains all client-related files. For more information about the Frontend, continue here.
- power-bi-desktop/: Contains the Power BI related files and some samples. For more information about it, continue here.
- screenshots/: Contains the screenshots created by the report generation.
- .achecker.yml: Contains the configuration for the IBM's Accessibility Checker
You'll need to install Node.js (>= 18.19.0) and then run the following commands afterward.
-
To set up everything before the first run just do one of the following steps:
- Install the node modules via
followed by
npm installwhich installs the headless browsers for Playwright, so it can take screenshots.npx playwright install - Or simply use the predefined command from the package.json which executes both of the previous commands
npm run setup
- Install the node modules via
-
With the following command, you'll start the Frontend on port 3000 (localhost:3000) and the Backend on port 42069 (localhost:42069).
npm run dev
Now you're good to go.
Note, if you're a developer: When saving code changes applying to files in the
- backend folder, the Backend server will automatically restart.
- frontend folder, the Frontend server will automatically perform a hot module reload (Reloading the browser page but also keeping the state of the application like user inputs or loaded data).
If you want to know more about how this works and what other scripts are available, have a look at scripts part in the package.json.