mahmoudhanyy/rest-boilerplate
Grade a repo

0

/ 100

GradeF

Lots of room to improve. Start with a README and CI.

Higher than 22% of 5,156 graded repos

Rest API base template (Boilerplate)

Documentation44
Engineering19
Health50
1MIT5y ago

A low grade is a to-do list, not a judgment of your code

Most gaps here are documentation, tests, and setup, not the code itself. Closing your top 3 gaps alone would lift this repo to C (73).

See your top fixes
Now
F
33
Potential
C
73

Top fixes

Highest-impact changes first, ranked by point weight

22 to address
  1. 1
    Tests18pt

    Add automated tests. They prove the code works and give contributors confidence to make changes.

  2. 2
    CI/CD14pt

    If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.

  3. 3
    README12pt

    Expand with a description, install steps, usage, and examples.

  4. 4
    README12pt

    Add more sections (Overview, Install, Usage, Contributing) using ## headings.

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

44

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.

README12pt33

README is present.

Install and run instructions9pt45

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

→ Add a section showing how to install dependencies.

License6pt100

Licensed under MIT.

Engineering

19

Tests18pt0

No tests detected anywhere in the repository.

→ Add automated tests. They prove the code works and give contributors confidence to make changes.

CI/CD14pt0

No CI configuration detected in this repository.

→ If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.

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 (package-lock.json). Installs are reproducible.

Linting and formatting5pt100

Linter or formatter configured (.eslintrc.json).

Project health

50

Activity5pt5

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

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

Dependency manifest6pt55

Dependency manifest found (package.json).

Repository metadata5pt60

Repository has a description.

Housekeeping3pt100

.gitignore present.

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
  • 1
    Watchers

Responsiveness

  • -
    Median issue response
  • -
    Median PR merge time
  • 0
    Open issues
Repository files8 root entries
  • src
  • .eslintrc.json
    Good: Linter or formatter configured (.eslintrc.json).
  • .gitignore
    Good: .gitignore present.
  • index.js
  • LICENSE
    Good: Licensed under MIT.
  • 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 fairly short (−10 pts). At 400+ chars you get partial credit; 1,500+ earns the full +20 pts.Fix: Expand with a description, install steps, usage, and examples.
    Issue: README has some structure (−7 pts). 2-3 headings earns partial credit; 4+ earns the full +15 pts.Fix: Add more sections (Overview, Install, Usage, Contributing) using ## 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.
    Good: README has code examples.
    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.
    Good: README documents how to run the project.
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/mahmoudhanyy/rest-boilerplate)](https://www.repo-grade.com/report/mahmoudhanyy/rest-boilerplate)

More graded repos