mwakidenis/chat-x2

0

/ 100

Documentation9
Engineering30
Health89
JavaScript54d ago
Grade a repo

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

This is a realtime chat app which allow users to sign in with Google, send messages, and see them instantly update across all connected users using Supabase Realtime sockets.

Documentation

9

Install and run instructions9pt0

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

→ Add a section showing how to install dependencies.

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.

README12pt25

README is present.

Engineering

30

Tests18pt0

No tests detected anywhere in the repository.

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

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

Linting and formatting5pt100

Linter or formatter configured (eslint.config.js).

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 health signals

Activity, community, and responsiveness at scan time

Activity

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

Community

  • 28% - Weak
    Community health
  • —
    authors own >50% of commits
  • 5
    Watchers

Responsiveness

  • —
    Median issue response
  • —
    Median PR merge time
  • 0
    Open issues
Repository files11 root entries
  • .github
    Good: CI is configured (.github/workflows/main.yml).
  • public
  • src
  • .gitignore
    Good: .gitignore present.
  • eslint.config.js
    Good: Linter or formatter configured (eslint.config.js).
  • index.html
  • 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.
    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.
    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.
  • updates.txt
  • vite.config.js