ops1ops/onliner-api-listener

0

/ 100

Documentation51
Engineering39
Health72
JavaScript12y ago
Grade a repo

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

Real time onliner.by price tracking system which saves every price change of tracked items to history

Documentation

51

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.

README12pt60

README is present.

Install and run instructions9pt100

README documents how to install the project.

Engineering

39

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.

Reproducibility6pt70

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

CI/CD14pt72

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

Linting and formatting5pt100

Linter or formatter configured (.eslintrc).

Project health

72

Activity5pt5

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

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

Dependency manifest6pt90

Dependency manifest found (package.json).

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

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

Community

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

Responsiveness

  • 1d 21h
    Median issue response
  • <1h
    Median PR merge time
  • 1
    Open issues
Repository files14 root entries
  • .github
    Good: CI is configured (.github/workflows/eslint.yml).
  • config
  • public
  • src
  • .babelrc
  • .env.example
  • .eslintrc
    Good: Linter or formatter configured (.eslintrc).
  • .gitignore
    Good: .gitignore present.
  • .sequelizerc
  • nodemon.json
  • 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.
    Good: README has code examples.
    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.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • webpack.config.js