portel-dev/photon
Grade a repo

91

/ 100

GradeA

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

Top 11% of 5,156 graded repos

Define intent once. Photon turns a single TypeScript file into CLI tools, MCP servers, and web interfaces.

Documentation97
Engineering84
Health100
TypeScript97MIT1mo ago

Top fixes

Highest-impact changes first, ranked by point weight

5 to address
  1. 1
    Install and run instructions9pt

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

  2. 2
    Reproducibility6pt

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

  3. 3
    Reproducibility6pt

    Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.

  4. 4
    Issue and PR templates6pt

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

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

97

Install and run instructions9pt90

README documents how to install the project.

Contributing guide5pt97

Contributing guide is detailed and thorough.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

84

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.

Reproducibility6pt70

Lockfile present (bun.lock). Installs are reproducible.

Tests18pt100

Test files detected (tests).

CI/CD14pt100

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

Linting and formatting5pt100

Linter or formatter configured (.prettierrc).

Project health

100

Dependency manifest6pt100

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

  • 56 / 779
    Commits (30d / 90d)
  • 5
    Forks
  • 54
    Releaseslatest 6mo ago

Community

  • 87% - Good
    Community health
  • 1 bus factorlow
    author own >50% of commits
  • 97
    Watchers

Responsiveness

  • 2d 1h
    Median issue response
  • 4h
    Median PR merge time
  • 0
    Open issues
Repository files34 root entries
  • .githooks
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
  • assets
  • bin
  • docs
  • docs-site
  • examples
  • packages
  • photons
  • screenshots
  • scripts
  • skills
  • src
  • templates
  • tests
    Good: Test files detected (tests).
  • wiki
  • .gitignore
    Good: .gitignore present.
  • .npmignore
  • .prettierrc
    Good: Linter or formatter configured (.prettierrc).
  • .release-it.json
  • bun.lock
    Good: Lockfile present (bun.lock). Installs are reproducible.
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Good: Contributing guide describes code style expectations.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • DESIGN.md
  • eslint.config.mjs
  • knip.json
  • LICENSE
    Good: Licensed under MIT.
  • package.json
    Good: Dependency manifest found (package.json).
  • playwright.config.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.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • SECURITY.md
    Good: Security policy present.
  • tsconfig.json
  • WHY-PHOTON.md
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/portel-dev/photon)](https://www.repo-grade.com/report/portel-dev/photon)

More graded TypeScript repos