Good shape overall. A few tweaks would push it into the top tier.
Mongoose module for Nest framework (node.js) ๐ธ
Documentation
80
Install and run instructions9pt
45
README documents how to install the project.
Contributing guide5pt
72
Contributing guide is detailed and thorough.
README12pt
100
README is present.
License6pt
100
Licensed under MIT.
Engineering
74
Tests18pt
35
Test files detected (tests).
Reproducibility6pt
80
Lockfile present (package-lock.json). Installs are reproducible.
CI/CD14pt
100
CI is configured (.circleci/config.yml).
Linting and formatting5pt
100
Linter or formatter configured (.prettierrc).
Issue and PR templates6pt
100
Issue or PR templates present.
Project health
95
Dependency manifest6pt
85
Dependency manifest found (package.json).
Repository metadata5pt
100
Repository has a description.
Activity5pt
100
Actively maintained (pushed within the last month).
Housekeeping3pt
100
.gitignore present.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- โCommits (30d / 90d)
- 115Forks
- 43Releaseslatest 5y ago
Community
- โCommunity health
- โauthors own >50% of commits
- 568Watchers
Responsiveness
- 3d 17hMedian issue response
- 4d 18hMedian PR merge time
- 4Open issues
Repository files22 root entries
- .circleciGood: CI is configured (.circleci/config.yml).
- .githubGood: Issue or PR templates present.
- .husky
- lib
- testsGood: Test files detected (tests).
- .commitlintrc.json
- .gitignoreGood: .gitignore present.
- .npmignore
- .nvmrc
- .prettierrcGood: Linter or formatter configured (.prettierrc).
- .release-it.json
- CONTRIBUTING.mdGood: Contributing guide is detailed and thorough.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).Good: Contributing guide describes the PR/review workflow.Good: Contributing guide includes code examples.
- docker-compose.ymlGood: Environment pinned via docker-compose.yml.
- LICENSEGood: Licensed under MIT.
- oxlint.json
- package-lock.jsonGood: Lockfile present (package-lock.json). Installs are reproducible.
- package.jsonGood: Dependency manifest found (package.json).
- README.mdGood: 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.Issue: No run or usage instructions found (โ45 pts).Fix: Add a section showing how to start or use the project.
- renovate.json
- tsconfig.build.json
- tsconfig.json
- vitest.config.ts