From 6845a6a797f8ff08ed4f38b0aa924e089656e046 Mon Sep 17 00:00:00 2001 From: fthrslntgy Date: Mon, 25 Dec 2023 16:03:14 +0300 Subject: [PATCH] Add readme files --- README.md | 11 +++++++++++ README_EN.md | 11 +++++++++++ 2 files changed, 22 insertions(+) create mode 100644 README.md create mode 100644 README_EN.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e18c4be --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# FastAPI Report Engine + +[Jinja2](https://palletsprojects.com/p/jinja/) formatında oluşturulmuş .docx uzantılı rapor şablonları kullanılarak özelleştirilmiş PDF ve CSV rapor almayı sağlayan raporlama servisi. + +## Kullanım +[Link](https://github.com/limanmys/fastapi-report-engine/releases/latest) üzerinden güncel deb paketi, Ubuntu 20.x ve 22.x sistemlere kurularak kullanılmaya başlanabilir. Sistem üzerinde `report-engine.service` servis adıyla ve `8001` portu üzerinden çalışmaktadır. + +## Dokümantasyon +Servis sağlıklı bir şekilde çalışıyorken `:8001/docs` adresi üzerinden Swagger dokümantasyonuna ulaşılabilir. + +![swagger.png](./images/swagger.png) \ No newline at end of file diff --git a/README_EN.md b/README_EN.md new file mode 100644 index 0000000..e540467 --- /dev/null +++ b/README_EN.md @@ -0,0 +1,11 @@ +# FastAPI Report Engine + +Reporting service that allows you to obtain customized PDF and CSV reports using .docx extension report templates created in [Jinja2](https://palletsprojects.com/p/jinja/) format. + +## Usage +You can start using the current deb package by installing it on Ubuntu 20.x and 22.x systems via the [link](https://github.com/limanmys/fastapi-report-engine/releases/latest) . It works on the system under the service name `report-engine.service` and over port `8001`. + +## Documentation +While the service is running properly, Swagger documentation can be accessed at [localhost:8001/docs](localhost:8001/docs). + +![swagger.png](./images/swagger.png) \ No newline at end of file