diff --git a/README.md b/README.md index e18c4be..11a69e4 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,17 @@ # 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. +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. -## 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. +## 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`. -## Dokümantasyon -Servis sağlıklı bir şekilde çalışıyorken `:8001/docs` adresi üzerinden Swagger dokümantasyonuna ulaşılabilir. +```bash +sudo apt install ./report-engine-47.deb +# to show service logs +sudo journalctl -u report-engine.service -f +``` + +## 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 diff --git a/README_EN.md b/README_EN.md deleted file mode 100644 index e540467..0000000 --- a/README_EN.md +++ /dev/null @@ -1,11 +0,0 @@ -# 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 diff --git a/README_TR.md b/README_TR.md new file mode 100644 index 0000000..510c343 --- /dev/null +++ b/README_TR.md @@ -0,0 +1,17 @@ +# 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. + +```bash +sudo apt install ./report-engine-47.deb +# servis loglarını görüntülemek için +sudo journalctl -u report-engine.service -f +``` + +## 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