docs: Basic readme
This commit is contained in:
parent
491d31e2e9
commit
7d571ad46b
31
README.md
Normal file
31
README.md
Normal 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
|
Loading…
x
Reference in New Issue
Block a user