fixable

fixable, provided by Accessible Community, is a site designed to show common accessibility errors and how to fix them.

Repository layout

• The site folder contains the javascript code used to build the site.
  • fixable is powered by Astro.

Setting up a Development Environment

If you don't have one, we recommend installing an IDE that supports multiple languages (Python, Javascript, HTML/CSS, etc). The recommendations are VS Code or Sublime Text, but this is a developer choice.

The next step is to determine which development environment you would like to use. You can choose between a couple of options:

• A direct Node.js install.
• Running in a Docker container.

Setting up a Development Environment using Node

Note: npm commands should be run within the site directory.

1. Install the LTS version of Node on your development machine.
   • If you need to manage multiple Node versions, you can use fnm or nvm
2. Run npm install within the site directory to install the JS dependencies.
3. Run npm start within the site directory to run the development server.

Other useful npm commands within the site directory:

• npm run check to check for TypeScript errors
• npm run build to create a production build
• npm run preview to preview the production build created by npm run build

This repository includes components designed to allow implementing both "broken" and "fixed" versions side-by-side.

To run the "fixed" version:

• npm run dev:fixed to run the dev server
• npm run build:fixed to run a build (previewable as before via npm run preview)

Note that the default "broken" version has been the initial focus of development, so the "fixed" version is even more work-in-progress.

Setting up a Development Environment using Docker

1. Install Docker Desktop or another way to run a containerized environment.

• If on Windows, we recommend installing the Linux Subsystem to help performance, but it’s not required. See configuring Docker Desktop to use WSL 2.

2. There are a series a make commands to help you run the commands in Docker. To use those, you'll need to install a way to run make.

• On Windows, use the Linux Subsystem or chocolatey.
• On Mac, install the Xcode client tools or use homebrew.
• If preferred, install some integration with the IDE you are using instead.
  • For instance, Makefile support for VS Code

3. Run make serve to launch the container, install the dependencies and run the development server.