Skip to content

chore: test, a11y, healthcheck, and docs improvements #294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
levoski1 merged 5 commits into from
Jul 26, 2026
Merged

chore: test, a11y, healthcheck, and docs improvements #294

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e868236
test: add unit tests for static dashboard script
micmusjnr20 Jul 25, 2026
d6594c7
feat: audit and fix dashboard accessibility issues
micmusjnr20 Jul 25, 2026
c50e1db
feat: enhance service healthcheck dependencies in docker compose
micmusjnr20 Jul 25, 2026
52433d0
docs: document docker-compose.override.yml purpose and usage
micmusjnr20 Jul 25, 2026
102f1f6
Merge pull request #2 from micmusjnr20/chore/four-improvements
micmusjnr20 Jul 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,27 @@ docker-compose ps
curl http://localhost:8000/health
```

### docker-compose.override.yml

A `docker-compose.override.yml` file is included in the repository. Docker
Compose [automatically merges]
(https://docs.docker.com/compose/how-tos/multiple-compose-files/merge/) this
file with `docker-compose.yml` when you run `docker-compose up`. The override
adds the **backend** and **frontend** services so you can run the full stack
locally without modifying the base compose file.

Developers commonly edit this file to:

- Point `VITE_API_URL` / `VITE_SOROBAN_RPC` to a different environment
- Adjust port mappings if the defaults conflict with other services
- Mount local source directories for hot-reloading during development

To inspect the effective compose configuration that Docker will use:

```sh
docker-compose config
```

### Deploying Contracts Locally

```sh
Expand Down
29 changes: 22 additions & 7 deletions dashboard/abi-explorer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@
overflow: hidden;
}
.fn-list.open { display: block; }
.contract-header:focus-visible {
outline: 2px solid #4f46e5;
outline-offset: 2px;
}
.fn-row {
display: flex;
align-items: baseline;
Expand All @@ -50,14 +54,15 @@
</style>
</head>
<body>
<a href="#explorer" class="skip-link">Skip to main content</a>
<div class="container">
<header>
<h1>ABI Explorer</h1>
<p style="color:#6b7280;font-size:0.875rem;margin-top:4px">
<p style="color:#4b5563;font-size:0.875rem;margin-top:4px">
Read-only reference for deployed COMEBACKHERE Protocol contracts.
</p>
</header>
<div id="explorer"></div>
<div id="explorer" role="main"></div>
</div>

<script>
Expand Down Expand Up @@ -173,22 +178,32 @@ <h1>ABI Explorer</h1>
}).join('');

return `<div class="contract-section">
<div class="contract-header" data-target="${id}" onclick="toggleSection(this)">
<h2>${abi.contract}</h2>
<div class="contract-header" data-target="${id}" onclick="toggleSection(this)" role="button" tabindex="0" aria-expanded="false" aria-controls="${id}">
<h2 id="${id}-title">${abi.contract}</h2>
<span class="version">v${abi.version}</span>
<span class="badge" style="background:#e0e7ff;color:#3730a3">${abi.functions.length} functions</span>
<span class="chevron">▶</span>
<span class="chevron" aria-hidden="true">▶</span>
</div>
<div class="fn-list" id="${id}">${fnRows}</div>
<div class="fn-list" id="${id}" role="region" aria-labelledby="${id}-title">${fnRows}</div>
</div>`;
}

function toggleSection(header) {
const target = document.getElementById(header.dataset.target);
header.classList.toggle('open');
const isOpen = header.classList.toggle('open');
target.classList.toggle('open');
header.setAttribute('aria-expanded', String(isOpen));
}

// Keyboard support: Enter / Space to toggle the collapsible sections
document.getElementById('explorer').addEventListener('keydown', (e) => {
const btn = e.target.closest('.contract-header');
if (btn && (e.key === 'Enter' || e.key === ' ')) {
e.preventDefault();
toggleSection(btn);
}
});

document.getElementById('explorer').innerHTML = ABIS.map(renderContract).join('');
</script>
</body>
Expand Down
Loading
Loading