fixable, provided by Accessible Community, is a site designed to show common accessibility errors and how to fix them.
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.
Note: npm commands should be run within the site directory.
- Install the LTS version of Node on your development machine.
- Run
npm installwithin thesitedirectory to install the JS dependencies. - Run
npm startwithin thesitedirectory to run the development server.
Other useful npm commands within the site directory:
npm run checkto check for TypeScript errorsnpm run buildto create a production buildnpm run previewto preview the production build created bynpm 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:fixedto run the dev servernpm run build:fixedto run a build (previewable as before vianpm 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.
- 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.
- There are a series a
makecommands to help you run the commands in Docker. To use those, you'll need to install a way to runmake.
- 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,
Makefilesupport for VS Code
- For instance,
- Run
make serveto launch the container, install the dependencies and run the development server.