Skip to content

Commit d9c305d

Browse files
committed
add README
1 parent d6d7ea1 commit d9c305d

File tree

1 file changed

+157
-0
lines changed

1 file changed

+157
-0
lines changed

README.md

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
# Vix.cpp
2+
3+
<p align="center">
4+
<img
5+
src="https://res.cloudinary.com/dwjbed2xb/image/upload/v1762524350/vixcpp_etndhz.png"
6+
alt="Vix.cpp Banner"
7+
width="100%"
8+
style="max-width:900px;border-radius:8px;"
9+
/>
10+
</p>
11+
12+
<h1 align="center">Vix.cpp</h1>
13+
14+
<p align="center">
15+
⚡ Offline-first · Peer-to-peer · Ultra-fast C++ runtime
16+
</p>
17+
18+
<p align="center">
19+
<img src="https://img.shields.io/badge/C%2B%2B-20-blue" />
20+
<img src="https://img.shields.io/badge/License-MIT-green" />
21+
<img src="https://img.shields.io/github/actions/workflow/status/vixcpp/vix/SECURITY_CI.yml?label=CI" />
22+
<img src="https://img.shields.io/github/stars/vixcpp/vix?style=flat" />
23+
<img src="https://img.shields.io/github/forks/vixcpp/vix?style=flat" />
24+
<img src="https://img.shields.io/github/issues/vixcpp/vix" />
25+
<img src="https://img.shields.io/badge/Status-Active-success" />
26+
<img src="https://img.shields.io/github/v/tag/vixcpp/vix" />
27+
</p>
28+
29+
<p align="center">
30+
⭐ If this vision resonates with you, consider starring the project.
31+
</p>
32+
33+
---
34+
35+
## What is Vix.cpp?
36+
37+
**Vix.cpp** is a modern **C++ runtime** designed as a serious alternative to **Node.js, Deno, and Bun**
38+
but engineered **from day one** for:
39+
40+
- unstable networks
41+
- offline-first environments
42+
- peer-to-peer systems
43+
- extreme native performance
44+
45+
> **Run applications like Node/Deno/Bun
46+
> with C++ speed, control, and predictability.**
47+
48+
Vix is not just a backend framework.
49+
It is a **runtime layer** for real-world distributed systems.
50+
51+
---
52+
53+
## Who is Vix.cpp for?
54+
55+
Vix.cpp is built for developers who:
56+
57+
- Build backend systems in **modern C++**
58+
- Need **predictable performance** (no GC pauses)
59+
- Target **offline-first or unreliable networks**
60+
- Work on **edge, local, or P2P systems**
61+
- Want a **Node/Deno-like DX**, but native
62+
63+
If you’ve ever thought _“I wish Node was faster and more reliable”_
64+
Vix is for you.
65+
66+
---
67+
68+
## Why Vix exists
69+
70+
Most modern runtimes assume:
71+
72+
- stable internet
73+
- cloud-first infrastructure
74+
- predictable latency
75+
- always-online connectivity
76+
77+
That is **not reality** for much of the world.
78+
79+
**Vix.cpp is built for real conditions first.**
80+
81+
---
82+
83+
## Performance is not a feature it’s a requirement
84+
85+
Vix.cpp is designed to remove overhead, unpredictability, and GC pauses.
86+
87+
### ⚡ Benchmarks (Dec 2025)
88+
89+
| Framework | Requests/sec | Avg Latency |
90+
| --------------------------- | ------------ | ----------- |
91+
|**Vix.cpp (pinned CPU)** | **~99,000** | 7–10 ms |
92+
| Vix.cpp (default) | ~81,400 | 9–11 ms |
93+
| Go (Fiber) | ~81,300 | ~0.6 ms |
94+
| Deno | ~48,800 | ~16 ms |
95+
| Node.js (Fastify) | ~4,200 | ~16 ms |
96+
| PHP (Slim) | ~2,800 | ~17 ms |
97+
| FastAPI (Python) | ~750 | ~64 ms |
98+
99+
---
100+
101+
## It really is this simple
102+
103+
```cpp
104+
#include <vix.hpp>
105+
106+
int main() {
107+
vix::App app;
108+
109+
app.get("/", [](Request&, Response& res){
110+
res.send("Hello from Vix.cpp 🚀");
111+
});
112+
113+
app.run(8080);
114+
}
115+
```
116+
117+
---
118+
119+
## Script mode Run C++ like a script
120+
121+
```bash
122+
vix run main.cpp
123+
vix dev main.cpp
124+
```
125+
126+
---
127+
128+
## Documentation
129+
130+
- [Introduction](docs/introduction.md)
131+
- [Quick Start](docs/quick-start.md)
132+
- [Architecture & Modules](docs/architecture.md)
133+
- [ORM Overview](docs/orm/overview.md)
134+
- [Benchmarks](docs/benchmarks.md)
135+
- [Examples](docs/examples/overview.md)
136+
- [Build & Installation](docs/build.md)
137+
- [CLI Options](docs/options.md)
138+
- [CLI Reference](docs/vix-cli-help.md)
139+
140+
## Module Documentation Index
141+
142+
- **Core** : [docs/modules/core.md](docs/modules/core.md)
143+
- **WebSocket** : [docs/modules/websocket.md](docs/modules/websocket.md)
144+
- **ORM** : [docs/modules/orm.md](docs/modules/orm.md)
145+
- **JSON** : [docs/modules/json.md](docs/modules/json.md)
146+
- **Utils** : [docs/modules/utils.md](docs/modules/utils.md)
147+
- **CLI** : [docs/modules/cli.md](docs/modules/cli.md)
148+
149+
---
150+
151+
## ⭐ Support the project
152+
153+
If you believe in modern C++ tooling, offline-first systems, and native performance,
154+
please consider starring the repository.
155+
156+
MIT License
157+

0 commit comments

Comments
 (0)