docs: Basic readme

This commit is contained in:
Nicolai Ort 2024-12-02 17:16:17 +01:00
parent 491d31e2e9
commit 7d571ad46b
Signed by: niggl
GPG Key ID: 13AFA55AF62F269F

31
README.md Normal file
View File

@ -0,0 +1,31 @@
# ✒️ Document generation microservices
## Features
- 📝 HTML pdf templates
- 📚 OpenAPI/Swagger documentation
- ⚡ High-performance with go and gotenberg
## 🚀 Quick Start
```bash
# Install dependencies
go mod download
# Generate the swagger docs
swag init
# Run the server
air
```
## 📖 API Documentation
Swagger UI is available at: `/swagger`
## 🛠️ Development
The project uses:
- 🏃‍♂️ go as the language and build tool
- 🌐 gofiber for the web framework