mwakidenis/inventory-management-system-mern-crud-app

0

/ 100

Documentation46
Engineering49
Health100
JavaScript53d ago
Grade a repo

Early stage. Tests, CI, and a strong README would raise this score quickly.

The GitHub repo Inventory-Management-System-MERN-CRUD-App 💻📂 is a public MERN stack project ⚡🌐 that lets users ➕✏️🗑️📦 manage products in MongoDB 🍃🗄️, with separate frontend 🎨 and backend 🛠️ folders and instructions to run the app using npm 📦🚀 and MongoDB Compass 🧭

Documentation

46

License6pt0

No license detected.

→ Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.

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.

README12pt55

README is present.

Install and run instructions9pt90

README documents how to install the project.

Engineering

49

Linting and formatting5pt0

No linter or formatter config found.

→ Add a linter config such as .eslintrc.json, .prettierrc, ruff.toml, or .golangci.yml to enforce consistent code style.

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/main.yml).

Reproducibility6pt70

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

Tests18pt80

Test files detected (Frontend/inventory_management_system/src/App.test.js).

Project health

100

Dependency manifest6pt100

Dependency manifest found (Backend/package.json).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository files6 root entries
  • .github
    Good: CI is configured (.github/workflows/main.yml).
  • Backend
    Good: Lockfile present (Backend/package-lock.json). Installs are reproducible.
    Good: Dependency manifest found (Backend/package.json).
  • Frontend
    Good: Test files detected (Frontend/inventory_management_system/src/App.test.js).
  • .gitignore
    Good: .gitignore present.
  • 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.
    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.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • updates.txt