xr843/fojinNew scan
96/ 100 · A

Polished and well engineered. Punching above its star count.

Buddhist Digital Text Platform — 9,200+ texts, 500+ sources, 8 UI languages, AI Q&A (RAG), knowledge graph, full-text search

Python316 starsApache-2.0updated today

Outstanding work. A score of 96/100 puts this repo in a very small tier of truly well-engineered open source projects.

DocumentationREADME, setup, examples, license
100
EngineeringTests, CI, linting, lockfiles
93
Project healthDescription, activity, stars, deps
100

What to fix first

The highest-impact improvements for this repo.

  1. 1
    Tests
    EngineeringIssue

    Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.

  2. 2
    CI/CD
    EngineeringInfo

    Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.

  3. 3
    Contributing guide
    DocumentationIssue

    Add code blocks showing example commands for setup, running tests, and submitting a PR.

Detailed breakdown

Documentation

100
  • README100
    • README is present.
    • README is well structured with multiple sections.
    • README includes screenshots or visuals. Great for first impressions.
    • README has code examples.
    • README links to a live demo or deployed app.
    • README includes status badges.
  • Install and run instructions100
    • README documents how to install the project.
    • README documents how to run the project.
    • .env.example is present. Contributors can see exactly which env vars to set.
  • License100
    • Licensed under Apache-2.0.
  • Contributing guide100
    • Contributing guide is detailed and thorough.
    • Contributing guide includes setup/install instructions.
    • Contributing guide describes code style expectations.
    • Contributing guide explains how to run tests.
    • Contributing guide describes the PR/review workflow.
    • Contributing guide has no code examples (−5 pts).Add code blocks showing example commands for setup, running tests, and submitting a PR.
    • Code of conduct present.

Engineering

93
  • Tests80
    • Test files detected (backend/pytest.ini).
    • Test files detected (80/100) but no test runner configured (−20 pts). Without a documented test command the suite cannot be verified by contributors.Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/ci.yml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI workflow runs a lint or format check.
    • CI runs type checking (tsc, mypy, cargo check, etc.).
    • Optional: report test coverage in CI.Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.
    • CI caches dependencies for faster runs.
  • Linting and formatting100
    • Linter or formatter configured (.editorconfig).
  • Reproducibility100
    • Lockfile present (backend/requirements.txt). Installs are reproducible.
    • Environment pinned via backend/Dockerfile.
    • Dependabot covers 3 ecosystems (pip, npm, github-actions). Dependencies stay current.
  • Issue and PR templates100
    • Issue or PR templates present.
    • Security policy present.

Project health

100
  • Dependency manifest100
    • Dependency manifest found (backend/pyproject.toml).
  • Repository metadata100
    • Repository has a description.
    • Primary language detected: Python.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 316 stars.
  • Housekeeping100
    • .gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 56
    Forks
  • 4
    Releaseslatest 3mo ago

Community

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

Responsiveness

  • 11d 14h
    Median issue response
  • <1h
    Median PR merge time
  • 8
    Open issues
Repository files24 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Dependabot covers 3 ecosystems (pip, npm, github-actions). Dependencies stay current.
    Good: Issue or PR templates present.
  • backend
    Good: Test files detected (backend/pytest.ini).
    Good: Lockfile present (backend/requirements.txt). Installs are reproducible.
    Good: Environment pinned via backend/Dockerfile.
    Good: Dependency manifest found (backend/pyproject.toml).
  • datasets
  • docs
  • e2e
  • elasticsearch
  • frontend
  • workers
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .env.example
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • ARCHITECTURE.md
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Good: Contributing guide describes code style expectations.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • DECISIONS.md
  • deploy.sh
  • docker-compose.yml
  • fojin-backup.sh
  • LICENSE
    Good: Licensed under Apache-2.0.
  • NOTICE
  • 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.