apmantza/pi-free
Grade a repo

86

/ 100

GradeB

Well engineered for its size. A portfolio piece worth showing off.

Top 20% of 5,156 graded repos

All-in-one free/freemium/paid model providers for Pi

Documentation80
Engineering87
Health97
TypeScript64MIT1mo ago

Top fixes

Highest-impact changes first, ranked by point weight

9 to address
  1. 1
    README12pt

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

  2. 2
    Install and run instructions9pt

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

  3. 3
    Install and run instructions9pt

    Add a .env.example listing all required environment variables so contributors know what to set up.

  4. 4
    Reproducibility6pt

    Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.

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

80

Install and run instructions9pt45

README documents how to install the project.

README12pt90

README is present.

Contributing guide5pt92

Contributing guide is detailed and thorough.

License6pt100

Licensed under MIT.

Engineering

87

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.

Reproducibility6pt90

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

Tests18pt100

Test files detected (tests).

CI/CD14pt100

CI is configured (.github/workflows/ci.yml).

Linting and formatting5pt100

Linter or formatter configured (lint script in package.json).

Project health

97

Dependency manifest6pt90

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)
  • 8
    Forks
  • 6
    Releaseslatest 1mo ago

Community

  • 57% - Fair
    Community health
  • -
    authors own >50% of commits
  • 64
    Watchers

Responsiveness

  • 12h
    Median issue response
  • <1h
    Median PR merge time
  • 1
    Open issues
Repository files26 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Dependabot covers 2 ecosystems (npm, github-actions). Dependencies stay current.
  • .pi
  • docs
  • lib
  • provider-failover
  • providers
  • scripts
  • tests
    Good: Test files detected (tests).
  • .gitignore
    Good: .gitignore present.
  • .npmignore
  • agents.md
  • banner.jpg
  • banner.png
  • banner.svg
  • CHANGELOG.md
  • config.ts
  • constants.ts
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • index.ts
  • LICENSE
    Good: Licensed under MIT.
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • provider-helper.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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • tsconfig.json
  • vitest.config.ts
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/apmantza/pi-free)](https://www.repo-grade.com/report/apmantza/pi-free)

More graded TypeScript repos