bndct-devops/tome
Grade a repo

0

/ 100

GradeA

Well engineered for its size. A portfolio piece worth showing off.

Self-hosted ebook library server with built-in reader, KOReader sync, OPDS feed, and reading stats. Single Docker image.

Documentation97
Engineering93
Health96
Python60AGPL-3.0today

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

Documentation

97

Install and run instructions9pt90

README documents how to install the project.

Contributing guide5pt97

Contributing guide is detailed and thorough.

README12pt100

README is present.

License6pt100

Licensed under AGPL-3.0.

Engineering

93

Reproducibility6pt80

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

CI/CD14pt85

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

Tests18pt100

Test files detected (tests).

Linting and formatting5pt100

Linter or formatter configured (frontend/eslint.config.js).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

96

Dependency manifest6pt86

Dependency manifest found (pyproject.toml).

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)
  • 3
    Forks
  • 15
    Releaseslatest 22d ago

Community

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

Responsiveness

  • 1h
    Median issue response
  • <1h
    Median PR merge time
  • 1
    Open issues
Repository files24 root entries
  • .github
    Good: CI is configured (.github/workflows/docker.yml).
    Good: Issue or PR templates present.
  • alembic
  • backend
  • docs
  • frontend
    Good: Linter or formatter configured (frontend/eslint.config.js).
    Good: Lockfile present (frontend/package-lock.json). Installs are reproducible.
  • scripts
  • skills
  • tests
    Good: Test files detected (tests).
  • website
  • .dockerignore
  • .gitignore
    Good: .gitignore present.
  • alembic.ini
  • 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.
    Issue: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.
    Good: Contributing guide includes code examples.
  • dev.sh
  • docker-compose.yml
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • install.sh
  • LICENSE
    Good: Licensed under AGPL-3.0.
  • NOTICE
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • 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.