portel-dev/photon

0

/ 100

Documentation97
Engineering84
Health100
TypeScript97MIT1d ago
Grade a repo

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

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

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

  • —
    Commits (30d / 90d)
  • 5
    Forks
  • 54
    Releaseslatest 4mo ago

Community

  • —
    Community health
  • —
    authors 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