Skip to content

doytsujin/Koa11y

 
 

Repository files navigation

Maintenance Notice:

This project was started as a volunteer effort by a group of people in Indianapolis, IN. After two years of working on it, it became harder and harder to pull in and retain talent to work on it consistently. Though there were passionate individuals interested, many lived an hour or more away and couldn't meet in person weekly to work on it. Attempts were made to work remotely, but efforts languished. Years have passed with little work on this project. Though we had big plans, higher priorities have won out. The last release of Koa11y still works as a basic reporting tool, however the built in A11y guidelines are already out of date. The project remains online, for others to reference or fork. the released version may not be compatible with the latest Unix based OS's that do not prioritize backwards compatibility.


Koa11y Logo

Koa11y

Koa11y is a desktop app that allows you to automatically detect accessibility (a11y) issues on webpages.

Screenshot of Koa11y

To download Koa11y, visit the website:


Koa11y is built with:


Development/Code Contributing

Koa11y is written in JavaScript, Sass, and HTML. It uses NW.js to interact with the OS and to be cross-platform.

To Open Dev Tools in Koa11y

  • Right-Click on the logo in the app.

To run source code locally (Win/OSX)

  1. Install Node (V4.0.0 or above)
  2. Download or clone this repo
  3. Run npm install
  4. Run npm start

To run source code locally (Ubuntu)

  1. Download or Clone this repo and go to it in the terminal.
  2. Update apt-get: sudo apt-get update
  3. Install Node.js: sudo apt-get install nodejs
  4. Install NPM: sudo apt-get install npm
  5. Create a symbolic link for node sudo ln -s /usr/bin/nodejs /usr/bin/node
  6. Run node -v to check if you have a version of Node that is 4.0.0 or above, if not, consult this.
  7. Download dependencies: npm install
  8. Run the app: npm start

If that works, then in the future you can just run npm start to run the app, the rest is all setup.

About

Easily check for website accessibility issues

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CSS 41.7%
  • JavaScript 41.3%
  • HTML 13.9%
  • Vue 3.1%