Back to Komga

Development guidelines

DEVELOPING.md

1.26.1767 B
Original Source

Development guidelines

Thanks a lot for contributing to Komga!

Commit messages

Komga's commit messages follow the Conventional Commits standard. This enables automatic versioning, releases, and release notes generation.

Project organization

Komga is composed of 4 projects:

  • komga: a Spring Boot backend server that hosts the APIs, but also serves the static assets of the frontend.
  • komga-webui: the legacy VueJS frontend, built at compile time and served by the backend at runtime.
  • next-ui: the new VueJS frontend, built at compile time and served by the backend at runtime.
  • komga-tray: a thin desktop wrapper that displays a tray-icon

Check the README.md files in each project for more details.