hackforla/food-oasis

0

/ 100

Documentation45
Engineering61
Health79
TypeScript81GPL-2.01d ago
Grade a repo

Getting some notice. Tests and CI would be the fastest wins.

Repository for the current redevelopment of the Food Oasis Los Angeles website

Documentation

45

Install and run instructions9pt0

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

→ Add a section showing how to install dependencies.

README12pt48

README is present.

Contributing guide5pt53

Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

License6pt100

Licensed under GPL-2.0.

Engineering

61

Tests18pt35

Test files detected (client/jest.config.cjs).

CI/CD14pt57

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

Reproducibility6pt80

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

Linting and formatting5pt100

Linter or formatter configured (client/.eslintrc.json).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

79

Dependency manifest6pt55

Dependency manifest found (package.json).

Housekeeping3pt60

.gitignore present.

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 57
    Forks
  • 101
    Releaseslatest 5y ago

Community

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

Responsiveness

  • <1h
    Median issue response
  • <1h
    Median PR merge time
  • 236
    Open issues
Repository files22 root entries
  • .github
    Good: CI is configured (.github/workflows/mainToHeroku.yml).
    Good: Issue or PR templates present.
  • .vscode
  • client
    Good: Test files detected (client/jest.config.cjs).
    Good: Linter or formatter configured (client/.eslintrc.json).
    Issue: Build artifacts or local files may be committed (client/.env) (−40 pts).Fix: Remove them and add to .gitignore.
  • doc
  • embed
  • server
  • thunder-tests
  • .dockerignore
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .grenrc.json
  • CONTRIBUTING.md
    Issue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Issue: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • docker-compose.yml
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • Dockerfile-jared
  • lerna.json
  • LICENSE
    Good: Licensed under GPL-2.0.
  • ncdata.geojson
  • 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 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.
    Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    Good: README links to a live demo or deployed app.
    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.
  • tsconfig.json