0

/ 100

GradeF

Early-stage engineering. The fastest wins are CI and test coverage.

Higher than 36% of 5,156 graded repos

Open-source uptime monitoring SaaS — real-time website & API health checks, instant email alerts, public status pages. Free/Pro plans via Paystack (M-Pesa). Built with React, Node.js & PostgreSQL. Made in Kenya 🇰🇪

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
51
Potential
B
80

Top fixes

Highest-impact changes first, ranked by point weight

14 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
    Install and run instructions9pt

    Add a section showing how to start or use the project.

  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

57

License6pt0

No license detected.

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

Contributing guide5pt25

Contributing guidance is in the README, not a dedicated CONTRIBUTING.md (−20 pts).

→ Moving it to a CONTRIBUTING.md makes it easier to find and keeps the README focused. A dedicated file earns +47 pts base.

Install and run instructions9pt55

README documents how to install the project.

README12pt100

README is present.

Engineering

32

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 (artifacts/api-server/test).

Reproducibility6pt70

Lockfile present (pnpm-lock.yaml). Installs are reproducible.

Linting and formatting5pt100

Linter or formatter configured (devDependency in package.json).

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

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

Community

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

Responsiveness

  • 10d 9h
    Median issue response
  • -
    Median PR merge time
  • 0
    Open issues
Repository files17 root entries
  • artifacts
    Good: Test files detected (artifacts/api-server/test).
  • lib
  • screenshots
  • scripts
  • .env.example
  • .gitignore
    Good: .gitignore present.
  • .npmrc
  • deploy.sh
  • ecosystem.config.cjs
  • git-cleanup.sh
  • LOCAL_DEV.md
  • package.json
    Good: Dependency manifest found (package.json).
  • pnpm-lock.yaml
    Good: Lockfile present (pnpm-lock.yaml). Installs are reproducible.
  • pnpm-workspace.yaml
  • 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.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • tsconfig.base.json
  • 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/wolvarex/guardix)](https://www.repo-grade.com/report/wolvarex/guardix)

More graded TypeScript repos