jzellis/kowloon
Grade a repo

0

/ 100

GradeF

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

Documentation54
Engineering58
Health70
JavaScript33today

Documentation

54

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.

README12pt70

README is present.

Install and run instructions9pt100

README documents how to install the project.

Engineering

58

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/docker.yml).

Reproducibility6pt80

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

Tests18pt100

Test files detected (jest.config.js).

Project health

70

Repository metadata5pt40

No repository description set on GitHub (−60 pts).

→ Add a one-line description in the repo Settings → About. It appears in search results and social previews.

Dependency manifest6pt55

Dependency manifest found (package.json).

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)
  • 6
    Forks
  • 0
    Releases

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 33
    Watchers

Responsiveness

  • 8d 8h
    Median issue response
  • 23d 15h
    Median PR merge time
  • 11
    Open issues
Repository files60 root entries
  • .github
    Good: CI is configured (.github/workflows/docker.yml).
  • .vscode
  • ActivityParser
  • config
  • docker
  • docs
  • instances
  • logs
  • methods
  • public
  • routes
  • routes_backup
  • schema
  • scripts
  • setup
  • tests
  • workers
  • .dockerignore
  • .env.bak
  • .env.example
  • .env.kwln1
  • .env.kwln2
  • .env.kwln3
  • .env.sample
  • .gitignore
    Good: .gitignore present.
  • Caddyfile.local
  • CLAUDE.md
  • DOCKER_QUICKSTART.md
  • docker-compose.yml
  • docker-compose.yml.old
  • DOCKER.md
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • Dockerfile.prod
  • ecosystem.config.cjs
  • FILE_STORAGE.md
  • index.js
  • install.sh
  • jest.config.js
    Good: Test files detected (jest.config.js).
  • kowloon-instance.sh
  • kowloon.code-workspace
  • Kowloon.js
  • LOCAL_TESTING.md
  • Makefile
  • MULTI_INSTANCE.md
  • MULTIPLE_INSTANCES.md
  • openapi.yamlx
  • ORPHANED_FILES_REPORT.md
  • orphaned_files.json
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • QUICKSTART.md
  • 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.
  • run-instance.sh
  • run-method.js
  • setup-docker.sh
  • setup-infra.sh
  • setup-local-https.sh
  • start-all.sh
  • test-file.txt
  • zip-kowloon.sh