Skip to content

Update READMEs #158

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
scottgerring merged 1 commit into from
Jan 20, 2026
Merged

Update READMEs #158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@ Each deployment model uses appropriate components optimized for the specific pla
| [User Management](./user-management/) | Manages user accounts, authentication, and profile information. Handles user registration, login, and JWT token issuance. | [API Docs](./user-management/docs/api.yaml) |
| [Sticker Award](./sticker-award/) | Manages the assignment of stickers to users. Tracks which users have which stickers and handles assignment/removal based on criteria like certification completion. | [API Docs](./sticker-award/docs/api.yaml) |
| [Sticker Catalogue](./sticker-catalogue/) | Manages the master catalog of available stickers. Handles sticker metadata, images, and provides catalog browsing functionality. | [API Docs](./sticker-catalogue/docs/api.yaml) |
| [Web Backend](./web-backend/) | Backend for Frontend (BFF) service handling OAuth 2.1 authentication and API proxying. | [README](./web-backend/README.md) |
| [Web Frontend](./web-frontend/) | React/Vite single-page application. | |
| [E2E Tests](./e2e/) | Playwright-based end-to-end tests. | [README](./e2e/README.md) |

## Observability

Expand Down
10 changes: 2 additions & 8 deletions e2e/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Playwright-based end-to-end tests for Stickerlandia. Can be pointed at any deplo
# Against local Docker Compose
mise run compose:ui-test

# Against AWS (uses DEPLOYMENT_HOST_URL from .env)
# Against AWS (fetches URL from CDK stack output)
mise run aws:ui-test

# Interactive mode
Expand All @@ -29,13 +29,7 @@ BASE_URL=https://example.com npx playwright test

## Configuration

Copy `.env.example` to `.env`:

```bash
BASE_URL=http://localhost:8080
TEST_USER_EMAIL=user@stickerlandia.com
TEST_USER_PASSWORD=Stickerlandia2025!
```
Test credentials can be overridden via `TEST_USER_EMAIL` and `TEST_USER_PASSWORD` env vars.

## Structure

Expand Down
11 changes: 9 additions & 2 deletions mise.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,13 @@ run = "npx playwright test --ui"
[tasks."aws:ui-test"]
description = "Run UI tests against AWS deployment"
dir = "e2e"
depends = ["ui-test:install", "env:setup"]
run = "npx playwright test"
depends = ["ui-test:install"]
run = """
BASE_URL=$(aws cloudformation describe-stacks \
--stack-name "StickerlandiaSharedResources-${ENV:-dev}" \
--query "Stacks[0].Outputs[?OutputKey=='BaseUrl'].OutputValue" \
--output text)
echo "Running tests against: $BASE_URL"
BASE_URL=$BASE_URL npx playwright test
"""

Loading