Repository navigation
chore: rewrite the README, move the tests and add CI with Dependabot - #8
Merged
Merged
Conversation
- banner.png at 2000x666, the same size as the freshman banner, in the party colors with the group shapes and a record - hero.png: the player's phone after a mock round, framed, on a transparent background - demo.mp4: two mock rounds with the dashboard, scoreboard and a phone side by side (1:43, 1080p) - demo.webp: a looping preview of the second round for the README, since GitHub does not play repository videos inline
…sh version - README.md in Traditional Chinese and README-en.md in English, linked to each other - Banner, badges, an overview with the phone hero, and a demo preview that links to the full video - Quick start, environment variables including FIVE_GROUPS, deployment, running a game, the song list, scoring, the tech stack and project layout - The API table moves into a collapsible section, and the README ends with contributing rules and a disclaimer
…st scripts - wrangler is a pinned dev dependency, so local runs, CI and Workers Builds use the same version - npm run dev, npm run deploy and npm test replace the npx and node commands - The install scripts npm blocks by default (esbuild, workerd) stay blocked; wrangler dev and a dry-run deploy work without them
- test.mjs moves to test/worker.test.mjs, which npm test finds with the built-in test runner - The runner reports the result, so the closing console.log is gone
- CI runs npm ci, npm test and a dry-run deploy on pushes to main and on pull requests, so an update that breaks the bundle fails before merging - Dependabot checks npm and GitHub Actions every Monday at 04:00 (Asia/Taipei), as in the freshman repo, grouping npm minor and patch updates and all Actions updates
- License badge and section for the AGPL-3.0 LICENSE now on main - Node 22 or newer, as wrangler requires; npm ci, npm test, npm run dev and npm run deploy - The tech stack and project layout list test/, package.json, CI and Dependabot
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Advanced Run ID:
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
README
README.mdin Traditional Chinese,README-en.mdin English, each linking to the other.FIVE_GROUPS) and deployment.github/assets/:banner.png: 2000x666, the same size as freshman's bannerhero.png: the player's phonedemo.webp: a looping preview of the demodemo.mp4: the full demo video (1:43, 3.5 MB)demo.mp4.Tests
test.mjsmoves out of the repository root totest/worker.test.mjs.npm testruns it with Node's built-in test runner.npm, CI and Dependabot
package.jsonpins wrangler (4.146.0) as a dev dependency, so local runs, CI and Workers Builds use the same version. It addsnpm run dev,npm run deployandnpm test.npm ci,npm testandwrangler deploy --dry-runon pushes to main and on pull requests. An update that breaks the Worker bundle fails before it is merged.Notes
package.json. Workers Builds should install the dependencies and then deploy with the pinned wrangler.wrangler devand the dry-run deploy work without them, so they stay blocked.Test plan
npm testwrangler devandwrangler deploy --dry-runwith the pinned wrangler; the dry-run uses no Cloudflare credentials