@@ -10,7 +10,7 @@ A sample **Actix Web** application demonstrating integration with **ClickHouse**
10
10
11
11
---
12
12
13
- ## Features
13
+ ## Features ✨
14
14
15
15
1 . ** Actix Web**
16
16
- Route handling (e.g., ` GET ` , ` POST ` )
@@ -62,17 +62,20 @@ A sample **Actix Web** application demonstrating integration with **ClickHouse**
62
62
```
63
63
64
64
65
- ### API Endpoints 📡:
66
- - GET /: example endpoint to check request id logic
67
- - GET /logs: Fetch logs from ClickHouse (optional query params for pagination).
68
- - GET /health: Basic health check.
69
- - GET /fail: Example endpoint that triggers an error or panic for demonstration.
65
+ ### API Endpoints 📡
70
66
71
- ### CLI Commands
67
+ | Endpoint | Method | Description | Example |
68
+ | --------------| ----------| -------------------------------| -------------------------------------|
69
+ | ` / ` | GET | Demo endpoint with request ID | ` curl http://localhost:1337 ` |
70
+ | ` /health ` | GET | More Text | ` curl http://localhost:1337/health ` |
71
+ | ` /logs ` | GET | Get paginated logs | ` curl "http://localhost:1337/logs?limit=5&offset=0" ` |
72
+ | ` /fail ` | GET | Trigger handle panic example | ` curl http://localhost:1337/fail ` |
73
+
74
+ ### CLI Commands 🛠️
72
75
- ` cargo run migrate ` : Run ClickHouse migrations.
73
76
- ` cargo run serve ` : Run the web server.
74
77
75
- ### Configuration
78
+ ### Configuration 🛠️
76
79
- ` confik.toml ` : Configuration file for the application.
77
80
- ` .env ` : Environment variables for the application (optional).
78
81
@@ -85,10 +88,10 @@ docker build -t klickhouse-example:latest .
85
88
docker build -t klickhouse-example:arm64 -f aarch64.Dockerfile .
86
89
```
87
90
88
- ## Contributing
91
+ ## Contributing 🤝
89
92
90
93
Feel free to open issues or PRs to improve this example — whether adding features or refining best practices. All suggestions are welcome!
91
94
92
- ## License
95
+ ## License 📄
93
96
94
97
This project is open-sourced under the MIT License - see the [ LICENSE] ( LICENSE ) file for details.
0 commit comments