A set of useful guides to building accessible components.
View the production version of this repo at https://accessible-components.sparkbox.com/.
Once you've installed all of the dependencies (npm install), you will need to establish your connection to the Airtable database.
- Copy the
.env.examplefile, make sure it's in the root of your project, and rename it.env.local. - Your
env.localfile should include the following:
AIRTABLE_API_KEY=<generate an API key from your Airtable account overview>
AIRTABLE_BASE_ID=<find the ID of your base in your Airtable API documentation>
This sets up your Airtable API for use in your project.
Then, run the development server:
npm run devOpen http://localhost:3000 with your browser to see the result.
Run npm run prepare for husky pre-commit hook.
You can start editing the page by modifying pages/index.js. The page auto-updates as you edit the file.
API routes can be accessed at http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.js.
The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.
| Command | Description |
|---|---|
npm run test |
Run a single test command. |
npm run test:watch |
Rerun tests continuously as files change. |
- Airtable. To view, log in with the crendentials found in 1Password.
- Jira
- Google Drive for additional content not yet in Airtable
We're aiming to support the following browsers to a high standard, meaning that behavior and design closely match the original specifications. A user can access all content and functionality, including the usability of required assistive devices, such as a keyboard and screen reader.
macOS
- Safari (last 2 major versions)
- Chrome (last 6 months)
- Firefox (last 6 months)
Windows
- Chrome (last 6 months)
- Firefox (last 6 months)
- Edge (last 6 months)
Mobile
- Safari (last 2 major versions)
- Chrome on Android (last 6 months)
- Firefox on Android (last 6 months)
Older browsers should still be accessible, but may not entirely match the designs. Dead browsers, such as IE11, are not supported.