84/ 100 · B
Popular and well-maintained. A little polish away from elite status.
Build Better Websites. Create modern, resilient user experiences with web fundamentals.
TypeScript33,061 starsMITupdated 5d ago
DocumentationREADME, setup, examples, license
EngineeringTests, CI, linting, lockfiles
Project healthDescription, activity, stars, deps
What to fix first
The highest-impact improvements for this repo.
- 1CI/CDEngineeringInfo
Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.
- 2CI/CDEngineeringInfo
Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.
- 3READMEDocumentationWarning
Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
Detailed breakdown
Documentation
87- README70
- README is present.
- README is well structured with multiple sections.
- No screenshots or images in the README (−20 pts).Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
- README has code examples.
- README links to a live demo or deployed app.
- No status badges in the README (−10 pts).Add CI/build status badges from shields.io or your CI provider to signal project health.
- Install and run instructions100
- README documents how to install the project.
- README documents how to run the project.
- .env.example is present. Contributors can see exactly which env vars to set.
- License100
- Licensed under MIT.
- Contributing guide90
- Contributing guide is detailed and thorough.
- Contributing guide includes setup/install instructions.
- Contributing guide lacks a code style section (−8 pts).Describe your linting/formatting rules and how to run them (e.g. npm run lint, ruff check .).
- Contributing guide explains how to run tests.
- Contributing guide describes the PR/review workflow.
- Contributing guide includes code examples.
- Optional: add a Code of Conduct (+5 pts).A CODE_OF_CONDUCT.md signals that your project is welcoming. GitHub has a template you can add in one click.
Engineering
83- Tests100
- Test files detected (demos/bookstore/app/actions/account/controller.test.ts).
- CI/CD100
Not applicable?
- CI is configured (.github/workflows/check-main.yaml).
- CI workflow runs tests.
- CI runs on pull requests, not just on pushes to main.
- CI workflow runs a lint or format check.
- Optional: add type checking to CI.Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.
- Optional: report test coverage in CI.Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.
- CI caches dependencies for faster runs.
- CI includes a build step.
- Linting and formatting75
- Linter or formatter configured (.prettierrc).
- Lint script wired into package.json.
- Reproducibility80
- Lockfile present (pnpm-lock.yaml). Installs are reproducible.
- Environment pinned via .nvmrc.
- No Dependabot config (adding it earns up to +20 pts).Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.
- Issue and PR templates0
- No issue or PR templates found (−90 pts).Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.
- Optional: add a SECURITY.md.A SECURITY.md explains how to responsibly disclose vulnerabilities. Worth adding once the project has real users.
Project health
81- Dependency manifest65
- Dependency manifest found (package.json).
- package.json is missing a description (−10 pts).Add a one-line description to package.json. It appears in npm search and on GitHub.
- package.json has no repository field (−10 pts).Add a `repository` field pointing to the GitHub URL so npm knows where the source lives.
- package.json has no keywords (−8 pts).Add a `keywords` array to help people find your package on npm.
- package.json has no homepage field (−7 pts).Add a `homepage` field pointing to your docs or project website.
- Repository metadata70
- Repository has a description.
- Primary language detected: TypeScript.
- Activity100
- Actively maintained (pushed within the last month).
- 33,061 stars.
- Housekeeping100
- .gitignore present.
Repository files24 root entries
- .agents
- .codex
- .githubGood: CI is configured (.github/workflows/check-main.yaml).
- .vscode
- decisions
- demosGood: Test files detected (demos/bookstore/app/actions/account/controller.test.ts).
- docs
- packages
- scripts
- template
- .env.example
- .gitignoreGood: .gitignore present.
- .nvmrcGood: Environment pinned via .nvmrc.
- .oxlintrc.json
- .prettierignore
- .prettierrcGood: Linter or formatter configured (.prettierrc).
- AGENTS.md
- CONTRIBUTING.mdGood: Contributing guide is detailed and thorough.Good: Contributing guide includes setup/install instructions.Info: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them (e.g. npm run lint, ruff check .).Good: Contributing guide explains how to run tests.Good: Contributing guide describes the PR/review workflow.Good: Contributing guide includes code examples.
- cspell.yml
- LICENSEGood: Licensed under MIT.
- package.jsonGood: Dependency manifest found (package.json).
- pnpm-lock.yamlGood: Lockfile present (pnpm-lock.yaml). Installs are reproducible.
- pnpm-workspace.yaml
- README.mdGood: README is present.Good: README is well structured with multiple sections.Warning: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.Good: README has code examples.Good: README links to a live demo or deployed app.Info: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.Good: README documents how to install the project.Good: README documents how to run the project.