jrsparl/book-search-engine

0

/ 100

Documentation31
Engineering74
Health42
JavaScript05y ago
Grade a repo

Rough and inactive. Tests, CI, and a fuller README would revive it.

Documentation

31

README12pt0

README is present.

Install and run instructions9pt0

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

→ Add a section showing how to install dependencies.

Contributing guide5pt77

CONTRIBUTING guide found.

License6pt100

A license file is present.

Engineering

74

Tests18pt35

Test files detected (node_modules/concat-map/test).

Reproducibility6pt80

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

CI/CD14pt100

CI is configured (node_modules/concat-map/.travis.yml).

Linting and formatting5pt100

Linter or formatter configured (node_modules/color-name/.eslintrc.json).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

42

Activity5pt5

No pushes in over 2 years. Looks unmaintained (−95 pts).

→ A recent commit signals the project is alive and worth using.

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.

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt65

Dependency manifest found (package.json).

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 0
    Forks
  • 0
    Releases

Community

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

Responsiveness

  • —
    Median issue response
  • —
    Median PR merge time
  • 0
    Open issues
Repository files6 root entries
  • client
    Good: .gitignore present.
  • node_modules
    Good: A license file is present.
    Good: Test files detected (node_modules/concat-map/test).
    Good: CI is configured (node_modules/concat-map/.travis.yml).
    Good: Linter or formatter configured (node_modules/color-name/.eslintrc.json).
    Issue: Build artifacts or local files may be committed (node_modules/.bin) (−40 pts).Fix: Remove them and add to .gitignore.
  • server
    Good: CONTRIBUTING guide found.
    Issue: CONTRIBUTING guide contents could not be read (−28 pts vs a readable file).Fix: Move the file to the repo root or docs/CONTRIBUTING.md so its setup, style, test, and PR sections can be graded.
    Good: Code of conduct present.
    Good: Environment pinned via server/node_modules/is-symbol/.nvmrc.
    Good: Issue or PR templates present.
    Good: Security policy present.
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • README.md
    Good: README is present.
    Issue: README is very short (−20 pts). 400+ characters earns +10 pts; 1,500+ earns +20 pts.Fix: Add an Overview, Install, Usage, and Contributing section at minimum.
    Issue: README has little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    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.
    Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    Issue: No live demo link in the README (−20 pts).Fix: Link to a deployed version, docs site, or demo video. Users want to see it running.
    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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.