kareadita/kavita

0

/ 100

Documentation83
Engineering86
Health100
C#10,962GPL-3.05d ago
Grade a repo

A top-tier open source project. Docs, tests, and CI are all in excellent shape.

Kavita is a fast, feature rich, cross platform reading server. Built with the goal of being a full solution for all your reading needs. Setup your own server and share your reading collection with your friends and family.

Documentation

83

Install and run instructions9pt45

README documents how to install the project.

Contributing guide5pt87

Contributing guide is detailed and thorough.

README12pt100

README is present.

License6pt100

Licensed under GPL-3.0.

Engineering

86

Tests18pt80

Test files detected (Kavita.Common.Tests/Extensions/EnumerableExtensionsTests.cs).

Reproducibility6pt80

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

CI/CD14pt85

CI is configured (.github/workflows/build-and-test.yml).

Linting and formatting5pt100

.NET formatting configured (.editorconfig).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (Kavita.sln).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository files42 root entries
  • .github
    Good: CI is configured (.github/workflows/build-and-test.yml).
    Good: Issue or PR templates present.
  • .vscode
  • Kavita.API
  • Kavita.Benchmark
  • Kavita.Common
  • Kavita.Common.Tests
    Good: Test files detected (Kavita.Common.Tests/Extensions/EnumerableExtensionsTests.cs).
  • Kavita.Database
  • Kavita.Database.Tests
  • Kavita.Email
  • Kavita.Integration.Tests
  • Kavita.Models
    Good: Licensed under GPL-3.0.
  • Kavita.Models.Tests
  • Kavita.Server
  • Kavita.Server.Tests
  • Kavita.Services
  • Kavita.Services.Tests
  • Logo
  • scripts
  • UI
    Good: Lockfile present (UI/Web/package-lock.json). Installs are reproducible.
  • .browserslistrc
  • .editorconfig
    Good: .NET formatting configured (.editorconfig).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .sonarcloud.properties
  • build.sh
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Good: Contributing guide describes code style expectations.
    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.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • copy_runtime.sh
  • docker-build.sh
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • entrypoint.sh
  • favicon.ico
  • FUNDING.yml
  • global.json
  • INSTALL.txt
  • Kavita.sln
    Good: Dependency manifest found (Kavita.sln).
  • Kavita.sln.DotSettings
  • LICENSE
  • monorepo-build.sh
  • openapi.json
  • pull_request_template.md
  • 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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • SECURITY.md
    Good: Security policy present.