jhonderson/actual-http-api

0

/ 100

Documentation70
Engineering72
Health83
JavaScript229MIT1d ago
Grade a repo

Good shape overall. A few tweaks would push it into the top tier.

Basic Actual Budget API exposed through HTTP endpoints

Documentation

70

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.

README12pt70

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

72

Linting and formatting5pt0

No linter or formatter found.

→ Add ESLint (eslint.config.js) and/or Prettier (.prettierrc), install them as devDependencies, and add a `lint` script to package.json.

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/CD14pt85

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

Reproducibility6pt92

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

Tests18pt100

Test files detected (__tests__).

Project health

83

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt65

Dependency manifest found (package.json).

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)
  • 48
    Forks
  • 40
    Releaseslatest 2y ago

Community

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

Responsiveness

  • 9h
    Median issue response
  • 17h
    Median PR merge time
  • 3
    Open issues
Repository files18 root entries
  • __mocks__
  • __tests__
    Good: Test files detected (__tests__).
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Dependabot configured for npm.
  • examples
  • grafana
  • src
  • .dockerignore
  • .env
    Issue: Build artifacts or local files may be committed (.env) (−40 pts).Fix: Remove them and add to .gitignore.
  • .gitignore
    Good: .gitignore present.
  • docker-compose.yml
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • entrypoint.sh
  • jest.config.js
  • LICENSE
    Good: Licensed under MIT.
  • 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.
    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.
  • server.js