gitsquared/node-geolite2-redist

0

/ 100

Documentation82
Engineering20
Health100
TypeScript119Other1d ago
Grade a repo

Popular for its size, but the engineering basics lag behind the interest.

Redistribution of MaxMind GeoLite2 GeoIP databases as an npm library

Documentation

82

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.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under Other.

Engineering

20

Tests18pt0

No tests detected anywhere in the repository.

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

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

CI is configured (.github/workflows/db-update.yml).

Reproducibility6pt70

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

Project health

100

Dependency manifest6pt100

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)
  • 18
    Forks
  • 14
    Releaseslatest 4y ago

Community

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

Responsiveness

  • 2h
    Median issue response
  • 8h
    Median PR merge time
  • 0
    Open issues
Repository files17 root entries
  • .github
    Good: CI is configured (.github/workflows/db-update.yml).
  • .husky
  • docs
  • redist
  • scripts
  • src
  • .gitignore
    Good: .gitignore present.
  • .npmignore
  • commitlint.config.cjs
  • EULA
  • LICENSE
    Good: Licensed under Other.
  • 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.
    Good: README includes screenshots or visuals. Great for first impressions.
    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.
  • SECURITY.md
    Good: Security policy present.
  • tsconfig.json
  • typedoc.json