khoj-ai/openpaper

0

/ 100

Documentation62
Engineering61
Health100
TypeScript360AGPL-3.01d ago
Grade a repo

Popular for its size, but the engineering basics lag behind the interest.

Open Paper is a workbench for managing your research library. Read, annotate, and understand your papers all in one place. Use an AI assistant to conduct your literature review.

Documentation

62

Contributing guide5pt0

No CONTRIBUTING.md found (−47 pts base + up to −53 pts more for content).

→ Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.

Install and run instructions9pt55

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

README12pt75

README is present.

License6pt100

Licensed under AGPL-3.0.

Engineering

61

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.

CI/CD14pt40

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

Tests18pt80

Test files detected (server/tests).

Reproducibility6pt80

Lockfile present (client/yarn.lock). Installs are reproducible.

Linting and formatting5pt100

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

Project health

100

Dependency manifest6pt100

Dependency manifest found (client/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)
  • 54
    Forks
  • 0
    Releases

Community

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

Responsiveness

  • 3h
    Median issue response
  • 8h
    Median PR merge time
  • 2
    Open issues
Repository files11 root entries
  • .github
    Good: CI is configured (.github/workflows/dockerize.yml).
  • client
    Good: Linter or formatter configured (client/eslint.config.mjs).
    Good: Lockfile present (client/yarn.lock). Installs are reproducible.
    Good: Environment pinned via client/Dockerfile.
    Good: Dependency manifest found (client/package.json).
  • jobs
  • server
    Good: Test files detected (server/tests).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • demo.gif
  • DEVELOPMENT.md
  • LICENSE
    Good: Licensed under AGPL-3.0.
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    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.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Good: README documents how to run the project.