abdelrhmansaid/rafeeq

0

/ 100

Documentation59
Engineering86
Health89
JavaScript54d ago
Grade a repo

Solid engineering. The main gap is visibility.

Muslim companion application.

Documentation

59

License6pt0

No license detected.

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

Contributing guide5pt25

Contributing guidance is in the README, not a dedicated CONTRIBUTING.md (−20 pts).

→ Moving it to a CONTRIBUTING.md makes it easier to find and keeps the README focused. A dedicated file earns +47 pts base.

README12pt80

README is present.

Install and run instructions9pt90

README documents how to install the project.

Engineering

86

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.

Reproducibility6pt82

Lockfile present (bun.lock). Installs are reproducible.

Tests18pt100

Test files detected (src/features/prayers/components/icons/PrayerIcon.spec.js).

CI/CD14pt100

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

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Project health

89

Dependency manifest6pt65

Dependency manifest found (package.json).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository files18 root entries
  • .github
    Good: CI is configured (.github/workflows/test.yml).
    Good: Dependabot configured for bun.
  • .vscode
  • public
  • scripts
  • src
    Good: Test files detected (src/features/prayers/components/icons/PrayerIcon.spec.js).
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitignore
    Good: .gitignore present.
  • .prettierrc.json
  • AGENTS.md
  • bun.lock
    Good: Lockfile present (bun.lock). Installs are reproducible.
  • eslint.config.mjs
  • index.html
  • jsconfig.json
  • netlify.toml
  • package.json
    Good: Dependency manifest found (package.json).
  • 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.
  • vite.config.js
  • vitest.config.js