An open API service indexing awesome lists of open source software.

https://github.com/accesswatch/azaccess


https://github.com/accesswatch/azaccess

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

          

# Accessibility at Arizona - Prototype Site

This repository contains the prototype for the University of Arizona Digital Accessibility website.

## ๐ŸŒ Live Site

Visit the live prototype: [https://accesswatch.github.io/azaccess/work/web/home.html](https://accesswatch.github.io/azaccess/work/web/home.html)

## ๐Ÿ“‹ About

This site provides comprehensive accessibility guidance for students, faculty, staff, and visitors at the University of Arizona. It includes:

- **Role-based guidance** for different roles (students, faculty, staff, developers, etc.)

Note: The Disability Resource Center (DRC) is the official system of record for student disability services, accommodations, and related policies. For official requests or policies, refer students and families to https://drc.arizona.edu/

- **Hub pages** for documents, media, web/apps, teaching, and governance
- **Tools and checklists** for accessibility testing and compliance
- **Support resources** and contact information
- **Blog** with updates on accessibility initiatives

## ๐Ÿ“– Key Documentation

| Document | Purpose |
| ------------------------------------------------------------------------ | -------------------------------------------------------------------------- |
| [ACCESSIBILITY-DEVELOPMENT-GUIDE.md](ACCESSIBILITY-DEVELOPMENT-GUIDE.md) | โญ Comprehensive guide for MCP servers, agents, and testing workflows |
| [ACCESSIBILITY-CI-PROPOSAL.md](ACCESSIBILITY-CI-PROPOSAL.md) | ๐Ÿ“ Proposal for GitHub Actions accessibility CI/CD for Arizona Quick Start |
| [vscode-terminal-accessibility.md](vscode-terminal-accessibility.md) | VS Code terminal accessibility configuration |
| [MANUAL-A11Y-REVIEW-CHECKLIST.md](MANUAL-A11Y-REVIEW-CHECKLIST.md) | Human testing checklist for accessibility validation |
| [PROJECT-FILES.md](PROJECT-FILES.md) | Complete file reference and project structure |

## ๐Ÿ—๏ธ Structure

- `work/web/` - Main prototype files
- `home.html` - Homepage with quick links and hubs
- `roles.html` - Role selection gateway page
- `accessibility-101.html` - Introduction to accessibility
- Various hub and guide pages
- `styles.css` - Shared stylesheet

## ๐Ÿš€ Publishing to GitHub Pages

### Quick Start: Automated Deployment (Recommended)

**One command does everything!**

```powershell
.\deploy-gh.ps1
```

This script automatically:

- โœ… Initializes git repository
- โœ… Creates GitHub repository
- โœ… Pushes your code
- โœ… Enables GitHub Pages
- โœ… Provides your live URL

**Requirements:**

- GitHub CLI installed: `winget install --id GitHub.cli`
- Authenticated: `gh auth login`

**Your site goes live in 2 minutes at:** `https://YOUR-USERNAME.github.io/azaccess/`

---

### Manual Setup (Alternative)

If you prefer to do it manually or don't have GitHub CLI:

1. **Initialize git** (run from `c:\code\azaccess`):

```powershell
git init
git add .
git commit -m "Initial commit: Accessibility prototype site"
git branch -M main
```

2. **Create GitHub repository**:

- Go to https://github.com/new
- Name: `azaccess`
- Public repository
- Don't initialize with README

3. **Push to GitHub**:

```powershell
git remote add origin https://github.com/accesswatch/azaccess.git
git push -u origin main
```

4. **Enable GitHub Pages**:
- Repository Settings > Pages
- Source: Deploy from a branch
- Branch: `main`, Folder: `/ (root)`
- Save

### Making Updates

After making changes to your HTML, CSS, or other files:

```powershell
# Quick update (auto-detects your username)
.\update-site.ps1 "Description of your changes"

# Or manually:
git add .
git commit -m "Description of your changes"
git push
```

GitHub Pages automatically rebuilds your site (1-2 minutes).

## ๐Ÿงช Local Development

To test locally, run a simple HTTP server from the root directory:

### Using Python:

```bash
python -m http.server 8000
```

Then visit: `http://localhost:8000/work/web/home.html`

### Using Node.js:

```bash
npx http-server -p 8000
```

## โœจ Features

- **WCAG 2.2 compliant** design patterns
- **Responsive layout** that works on mobile and desktop
- **Skip links** for keyboard navigation
- **High contrast** color scheme (Arizona brand colors)
- **Semantic HTML** structure
- **Clear focus indicators** for keyboard users

## ๐Ÿ“ž Contact

For questions about accessibility at the University of Arizona:

- Email: accessibility@arizona.edu
- Phone: 520-621-3268

## ๐Ÿ“„ License

ยฉ 2025 The Arizona Board of Regents on behalf of The University of Arizona

## Accessibility Scanner & Dashboard

- **GitHub Action:** A workflow runs the GitHub Accessibility Scanner on `push`, `pull_request`, and nightly (03:00 UTC). It writes a JSON report to `reports/accessibility.json` and commits it into `docs/reports/` so the data is published to GitHub Pages.
- **WCAG scope:** The scanner is configured to report WCAG AA-level findings only (WCAG 2.2 AA focus), excluding AAA-level checks. See `.accessibility-scanner.yml`.
- **Dashboard:** A static dashboard page is available at [docs/accessibility-dashboard.html](docs/accessibility-dashboard.html) that renders actionable lessons learned and remediation suggestions based on scan results.

- **Historical trends:** The workflow also preserves timestamped JSON reports in `docs/reports/history/` and maintains `docs/reports/history/index.json`. The dashboard renders a recent trend sparkline and latest history entry. The history retention is capped (365 entries) and can be adjusted in `scripts/record-accessibility-history.js`.