docs: Updated readme

This commit is contained in:
Nicolai Ort 2024-12-11 19:29:04 +01:00
parent 924f76a100
commit e89c17806f
Signed by: niggl
GPG Key ID: 13AFA55AF62F269F

View File

@ -2,7 +2,7 @@
## Features
- 📝 HTML pdf templates
- 📝 HTML templates for pdf generation
- 📚 OpenAPI/Swagger documentation
- ⚡ High-performance with go and gotenberg
@ -12,9 +12,6 @@
# Install dependencies
go mod download
# Generate the swagger docs
swag init
# Run the server
air
```
@ -29,3 +26,38 @@ The project uses:
- 🏃‍♂️ go as the language and build tool
- 🌐 gofiber for the web framework
- 📦 air for live reload
- 📝 swaggo for API documentation
- 📄 gotenberg for HTML to PDF conversion
### 📦 Use docker compose for external dependencies
```shell
docker compose -f docker-compose.dev.yaml up
```
### 🏃 Run via air
> Install air via `go install github.com/air-verse/air@latest`
```shell
air
```
### ✒️ Update the swagger docs
> Install swag via `go install github.com/swaggo/swag/cmd/swag@latest`
```shell
swag init
```
### 🐋 Build container
```shell
# single arch
docker build -t registry.odit.services/lfk/document-server:latest .
# multiarch
docker buildx build --platform=linux/amd64,linux/arm64 -t registry.odit.services/lfk/document-server:latest --push .
```