Skip to content

Commit 612ea60

Browse files
committed
Update readme files
1 parent a72e26e commit 612ea60

3 files changed

Lines changed: 28 additions & 16 deletions

File tree

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
# FastAPI Report Engine
22

3-
[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.
3+
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.
44

5-
## Kullanım
6-
[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.
5+
## Usage
6+
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`.
77

8-
## Dokümantasyon
9-
Servis sağlıklı bir şekilde çalışıyorken `<IP_ADDR>:8001/docs` adresi üzerinden Swagger dokümantasyonuna ulaşılabilir.
8+
```bash
9+
sudo apt install ./report-engine-47.deb
10+
# to show service logs
11+
sudo journalctl -u report-engine.service -f
12+
```
13+
14+
## Documentation
15+
While the service is running properly, Swagger documentation can be accessed at [localhost:8001/docs](localhost:8001/docs).
1016

1117
![swagger.png](./images/swagger.png)

README_EN.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

README_TR.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# FastAPI Report Engine
2+
3+
[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.
4+
5+
## Kullanım
6+
[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.
7+
8+
```bash
9+
sudo apt install ./report-engine-47.deb
10+
# servis loglarını görüntülemek için
11+
sudo journalctl -u report-engine.service -f
12+
```
13+
14+
## Dokümantasyon
15+
Servis sağlıklı bir şekilde çalışıyorken `<IP_ADDR>:8001/docs` adresi üzerinden Swagger dokümantasyonuna ulaşılabilir.
16+
17+
![swagger.png](./images/swagger.png)

0 commit comments

Comments
 (0)