prushka/sparkle
Grade a repo

53

/ 100

GradeF

Getting some notice. Tests and CI would be the fastest wins.

Higher than 38% of 5,156 graded repos

A web-based watch party with room and HDR support. Can be used directly in Discord as an App.

Documentation62
Engineering33
Health89
TypeScript101mo ago

A low grade is a to-do list, not a judgment of your code

Most gaps here are documentation, tests, and setup, not the code itself. Closing your top 3 gaps alone would lift this repo to B (80).

See your top fixes
Now
F
53
Potential
B
80

Top fixes

Highest-impact changes first, ranked by point weight

13 to address
  1. 1
    Tests18pt

    Set scripts.test in package.json to your actual test command, e.g. "vitest" or "jest".

  2. 2
    CI/CD14pt

    If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.

  3. 3
    README12pt

    Add CI/build status badges from shields.io or your CI provider to signal project health.

  4. 4
    License6pt

    Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.

Working through the fixes? Let every push regrade itself.

The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

62

License6pt0

No license detected.

→ Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.

Contributing guide5pt0

No CONTRIBUTING.md found (−47 pts base + up to −53 pts more for content).

→ Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.

README12pt90

README is present.

Install and run instructions9pt100

README documents how to install the project.

Engineering

33

CI/CD14pt0

No CI configuration detected in this repository.

→ If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.

Issue and PR templates6pt0

No issue or PR templates found (−100 pts).

→ Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.

Tests18pt35

Test files detected (backend/internal/jobs/store_test.go).

Reproducibility6pt80

Lockfile present (package-lock.json). Installs are reproducible.

Linting and formatting5pt100

Linter or formatter configured (.prettierrc).

Project health

89

Dependency manifest6pt65

Dependency manifest found (package.json).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • -
    Commits (30d / 90d)
  • 0
    Forks
  • 0
    Releases

Community

  • 28% - Weak
    Community health
  • -
    authors own >50% of commits
  • 10
    Watchers

Responsiveness

  • -
    Median issue response
  • -
    Median PR merge time
  • 1
    Open issues
Repository files30 root entries
  • app
  • assets
  • backend
    Good: Test files detected (backend/internal/jobs/store_test.go).
  • chess
  • components
  • lib
  • public
  • scripts
  • types
  • .dockerignore
  • .env.example
  • .gitignore
    Good: .gitignore present.
  • .npmrc
  • .prettierignore
  • .prettierrc
    Good: Linter or formatter configured (.prettierrc).
  • build.sh
  • components.json
  • compose.example.yml
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • eslint.config.mjs
  • next.config.mjs
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • postcss.config.js
  • proxy.ts
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Good: README has code examples.
    Good: README links to a live demo or deployed app.
    Issue: 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.
  • start-backend.sh
  • tailwind.config.js
  • TODO
  • tsconfig.json
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/prushka/sparkle)](https://www.repo-grade.com/report/prushka/sparkle)

More graded TypeScript repos