Skip to content

Commit 7a4b464

Browse files
committed
Initial r3x engine setup - Ruby workflow executor
1 parent e72000f commit 7a4b464

1 file changed

Lines changed: 14 additions & 18 deletions

File tree

README.md

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,20 @@
1-
# README
1+
# r3x
22

3-
This README would normally document whatever steps are necessary to get the
4-
application up and running.
3+
Ruby-native workflow executor and automation engine. File-based workflow definitions with database runtime state. Built for local-first execution, self-hosting, and Git-native version control.
54

6-
Things you may want to cover:
5+
Rails API backend with SQLite, Active Record, and Active Job. Supports staged DAG execution, pack-based extensibility, and multiple executor backends.
76

8-
* Ruby version
7+
## Quick Start
98

10-
* System dependencies
9+
```bash
10+
mise install
11+
bundle install
12+
bin/rails db:setup
13+
bin/rails server
14+
```
1115

12-
* Configuration
16+
## Test
1317

14-
* Database creation
15-
16-
* Database initialization
17-
18-
* How to run the test suite
19-
20-
* Services (job queues, cache servers, search engines, etc.)
21-
22-
* Deployment instructions
23-
24-
* ...
18+
```bash
19+
bin/rails test
20+
```

0 commit comments

Comments
 (0)