Skip to content

Prep repo for public release: README, MIT license, CI - #77

Merged
lsanch78 merged 6 commits into
masterfrom
dev/public-release-prep
Jun 10, 2026
Merged

Prep repo for public release: README, MIT license, CI#77
lsanch78 merged 6 commits into
masterfrom
dev/public-release-prep

Conversation

@lsanch78

Copy link
Copy Markdown
Owner

Summary

Prepares the repo to be flipped public as a portfolio/showcase project:

  • README.md — pitch, feature list, tech stack, architecture overview (links CLAUDE.md and ADRs), local setup, testing, and engineering-practices sections. Screenshot section left as a TODO.
  • LICENSE — MIT (copyright holder set to lsanch78; swap in legal name if preferred), plus license: MIT in package.json.
  • CI.github/workflows/ci.yml runs tsc -b --noEmit and jest on pushes to master and all PRs.
  • QuickCast test fixb481d79 made QuickCast collapsed by default, breaking 5 tests that expected the expanded view. Tests now expand via the real toggle (renderOpen helper) and a new test pins the collapsed-by-default contract. 270/270 passing.

Security check done before this PR: .env was never committed (only .env.example is tracked), .gitignore covers it, and the stale unused VITE_PDL_API_KEY was removed from the local .env.

How to Test

  1. npm ci
  2. npx tsc -b --noEmit — clean
  3. npm test — 19 suites, 270 tests pass
  4. View README rendering on this branch in GitHub
  5. Confirm the CI check on this PR goes green

Potential Opportunities For Simplification

  • The README setup section duplicates some structure description from CLAUDE.md; if they drift, consider making README link-only for architecture.
  • renderOpen in QuickCast.test.tsx could move to a shared test util if other collapsible HUD components (Journal) grow similar tests.

🤖 Generated with Claude Code

lsanch78 and others added 4 commits June 10, 2026 15:17
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@vercel

vercel Bot commented Jun 10, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
effjobhunt Ready Ready Preview, Comment Jun 10, 2026 11:22pm

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@lsanch78
lsanch78 merged commit 1a77394 into master Jun 10, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant