Skip to content

Commit d5c0044

Browse files
authored
chore: update README.md
1 parent fa42899 commit d5c0044

File tree

1 file changed

+23
-10
lines changed

1 file changed

+23
-10
lines changed

Diff for: README.md

+23-10
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# Actix Web + Klickhouse Example
1+
# Actix Web + Klickhouse Example 🚀
2+
3+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
4+
[![Rust Version](https://img.shields.io/badge/Rust-1.83%2B-blue.svg)](https://www.rust-lang.org/)
5+
[![Actix Web](https://img.shields.io/badge/Actix%20Web-4.9-brightgreen.svg)](https://actix.rs/)
6+
[![ClickHouse](https://img.shields.io/badge/ClickHouse-24.3.7%2B-orange.svg)](https://clickhouse.com/)
7+
![CI Status](https://img.shields.io/badge/build-passing-brightgreen)
28

39
A sample **Actix Web** application demonstrating integration with **ClickHouse** using the [klickhouse](https://github.com/katanacap/klickhouse) library. This example covers essential aspects of building a web service in Rust, including routing, middleware, and database connectivity.
410

@@ -24,8 +30,8 @@ A sample **Actix Web** application demonstrating integration with **ClickHouse**
2430

2531
## Getting Started
2632

27-
### Prerequisites
28-
- **Devenv** (for running the application under development environment)
33+
### Prerequisites 🛠️
34+
- **Devenv** - https://devenv.sh/ (for running the application under development environment)
2935

3036
### Installation
3137

@@ -46,9 +52,17 @@ A sample **Actix Web** application demonstrating integration with **ClickHouse**
4652
3. **Access the application**:
4753
- Open your browser and navigate to `http://localhost:1337/health` to check if the application is running.
4854
- Open your browser and navigate to `http://localhost:1337/logs?limit=10&offset=0` to view the logs.
55+
56+
4. **Run tests + all rust checks**:
57+
```bash
58+
// cargo test/fmt/clippy/audit/outdated
59+
just
60+
// only tests
61+
just test
62+
```
4963

5064

51-
### Endpoints:
65+
### API Endpoints 📡:
5266
- GET /: example endpoint to check request id logic
5367
- GET /logs: Fetch logs from ClickHouse (optional query params for pagination).
5468
- GET /health: Basic health check.
@@ -62,14 +76,13 @@ A sample **Actix Web** application demonstrating integration with **ClickHouse**
6276
- `confik.toml`: Configuration file for the application.
6377
- `.env`: Environment variables for the application (optional).
6478

65-
### Docker build
79+
### Docker build 🐳
6680
```shell
67-
docker build -t klickhouse_example .
68-
```
81+
# x86_64
82+
docker build -t klickhouse-example:latest .
6983

70-
### Docker build for aarch64
71-
```shell
72-
docker build -t klickhouse-example-img -f aarch64.Dockerfile .
84+
# ARM64
85+
docker build -t klickhouse-example:arm64 -f aarch64.Dockerfile .
7386
```
7487

7588
## Contributing

0 commit comments

Comments
 (0)