Skip to content

Commit 8321b48

Browse files
Merge pull request #12 from rohas-dev/feat/docs
feat(docs): update README with project overview, features, quick start guide, and add initial screenshots
2 parents fe72420 + 3444034 commit 8321b48

6 files changed

Lines changed: 78 additions & 1 deletion

File tree

README.md

Lines changed: 78 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,78 @@
1-
# rohas
1+
# Rohas (WIP)
2+
3+
**The events you know. Built for AI-powered applications.**
4+
5+
Build scalable event-driven applications with schema-driven development. Python runtime support (fully support) with experimental TypeScript support, multiple event adapters, and powerful code generation.
6+
7+
## Features
8+
9+
- **Schema-Driven Development** - Define APIs, events, models, and cron jobs using simple schema files
10+
- **Multi-Runtime Support** - Write handlers in Python (production-ready) or TypeScript/Node.js (experimental)
11+
- **Event Adapters** - Connect to NATS, Kafka, RabbitMQ, SQS, or use in-memory adapters
12+
- **Code Generation** - Auto-generate type-safe interfaces and handler stubs
13+
- **Built-in Telemetry** - Integrated tracing, metrics, and logging
14+
- **Hot Reload** - Development server with automatic reloading
15+
16+
## Workbench
17+
18+
Rohas includes a powerful workbench for visualizing, debugging, and monitoring your event-driven applications in real-time.
19+
20+
<div align="center">
21+
<img src="docs/images/screenshot_1.png" alt="Rohas Workbench - Schema Management" width="800"/>
22+
</div>
23+
24+
<div align="center">
25+
<img src="docs/images/screenshot_3.png" alt="Rohas Workbench - Event Tracing" width="800"/>
26+
<img src="docs/images/screenshot_4.png" alt="Rohas Workbench - Schema Graph" width="800"/>
27+
</div>
28+
29+
## Quick Start
30+
31+
### Installation
32+
33+
```bash
34+
curl -fsSL https://raw.githubusercontent.com/rohas-dev/rohas/main/scripts/build.sh | bash
35+
```
36+
37+
### Initialize a Project
38+
39+
```bash
40+
# Python (recommended)
41+
rohas init my-app --lang python
42+
43+
# TypeScript (experimental)
44+
rohas init my-app --lang typescript
45+
```
46+
47+
### Start Development
48+
49+
```bash
50+
rohas dev --workbench
51+
```
52+
53+
## Roadmap
54+
55+
### Current Status
56+
57+
✅ Schema-driven development with `.ro` files
58+
✅ Python runtime (production-ready)
59+
✅ TypeScript runtime (experimental)
60+
✅ Event adapters
61+
✅ Code generation for type-safe handlers
62+
✅ Development server with hot reload
63+
✅ Workbench UI for development
64+
65+
### Upcoming
66+
67+
For the complete roadmap, visit: https://www.rohas.dev/en/docs/roadmap
68+
69+
## Documentation
70+
71+
For complete documentation, examples, and guides, visit:
72+
73+
- **Website**: https://www.rohas.dev/
74+
- **Documentation**: https://www.rohas.dev/en/docs
75+
76+
## License
77+
78+
MIT License - see [LICENSE](LICENSE) file for details.

docs/images/screenshot_1.png

766 KB
Loading

docs/images/screenshot_2.png

496 KB
Loading

docs/images/screenshot_3.png

649 KB
Loading

docs/images/screenshot_4.png

1.69 MB
Loading

docs/images/screenshot_5.png

495 KB
Loading

0 commit comments

Comments
 (0)