ycbing/shortify-ai

0

/ 100

Documentation90
Engineering53
Health82
TypeScript87MIT1d ago
Grade a repo

Strong early engineering with some momentum.

AI短剧创作

Documentation

90

README12pt80

README is present.

Contributing guide5pt86

Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

Install and run instructions9pt100

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

53

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 (app/api/model-configs/test).

CI/CD14pt72

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

Reproducibility6pt80

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

Linting and formatting5pt100

Linter or formatter configured (eslint.config.mjs).

Project health

82

Repository metadata5pt40

No repository description set on GitHub (−60 pts).

→ Add a one-line description in the repo Settings → About. It appears in search results and social previews.

Dependency manifest6pt93

Dependency manifest found (package.json).

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)
  • 16
    Forks
  • 0
    Releases

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 87
    Watchers

Responsiveness

  • —
    Median issue response
  • —
    Median PR merge time
  • 0
    Open issues
Repository files30 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
  • app
    Good: Test files detected (app/api/model-configs/test).
  • components
  • lib
  • public
  • scripts
  • server
  • types
  • .dockerignore
  • .env.example
  • .gitignore
    Good: .gitignore present.
  • .nvmrc
  • AGENTS.md
  • CLAUDE.md
  • components.json
  • CONTRIBUTING.md
    Issue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    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.
  • docker-compose.yml
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • drizzle.config.ts
  • ecosystem.config.js
  • eslint.config.mjs
    Good: Linter or formatter configured (eslint.config.mjs).
  • LICENSE
    Good: Licensed under MIT.
  • middleware.ts
  • next.config.ts
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • postcss.config.mjs
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Issue: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    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.
  • tailwind.config.ts
  • tsconfig.json