Backup_Repos/komga
1
0
Fork 0
mirror of https://github.com/gotson/komga.git synced 2026-01-03 22:36:07 +01:00
Code Issues Projects Releases Wiki Activity

docs: update DEVELOPING.md instructions

Browse source
This commit is contained in:
Gauthier Roebroeck 2023-03-03 15:10:53 +08:00
parent 8666b94bad
commit cd3687dca7
1 changed files with 1 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
DEVELOPING.md
View file

@ -11,15 +11,12 @@ You will need:
## Setting up the project
- run `npm install` in the root folder of the project. This will install the necessary commit hooks.
- run `npm install` in the `komga-webui` folder of the project. This will install the necessary tooling for the webui.
## Commit messages
Komga's commit messages follow the [Conventional Commits](https://www.conventionalcommits.org/) standard. This enables automatic versioning, releases, and release notes generation.
Commit messages are enforced using commit hooks ran on the developer's PC.
## Project organization
Komga is composed of 2 projects:
@ -71,6 +68,4 @@ Make sure you start the backend with the `dev` profile, else the frontend reques
To build the Docker image, you need to:
- have the webui built and copied to `/resources/public`. To do so, run `./gradlew copyWebDist`
- unpack the jar into layers expected by the `Dockerfile`. To do so, run `./gradlew unpack`
Then you can run `docker build -f ./komga/Dockerfile .`
- build the docker image via JReleaser. To do so, run `./gradlew jreleaserPackage`