Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ deno.lock
.DS_Store
.idea
.dev
mprocs.log
27 changes: 4 additions & 23 deletions docsite/docs/ecosystem/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,38 +79,19 @@ Make sure your Rust toolchain is up to date and install the CLI tools:

```sh
rustup update
cargo install typeshare-cli runnables-cli
cargo install typeshare-cli runnables-cli mprocs
run link-client
```

### Starting the services

Start a Mongo instance in Docker:
Run `run dev` to start the database, Core, Periphery, and UI all at once using [mprocs](https://github.com/pvolok/mprocs). Each process gets its own scrollable pane — use the arrow keys to switch between them and `Ctrl-Q` to quit.

```sh
docker run -d --name komodo-mongo \
-p 27017:27017 \
-v komodo-mongo-data:/data/db \
-v komodo-mongo-config:/data/configdb \
-e MONGO_INITDB_ROOT_USERNAME=komodo \
-e MONGO_INITDB_ROOT_PASSWORD=komodo \
mongo
run dev
```

In separate terminals, run Core, Periphery, and UI.

```sh
run dev-core
```

```sh
run dev-periphery

```sh
run dev-ui # Start in dev (watch) mode
```

Once everything is running, open `http://localhost:5173` and create a user account.
Once Core and the UI are running, open `http://localhost:5173` and create a user account.

### Rebuilding the frontend client

Expand Down
5 changes: 5 additions & 0 deletions mprocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
procs:
ui: "run dev-ui"
core: "run dev-core"
periphery: "run dev-periphery"
db: "docker run --rm -p 27017:27017 -v komodo-ferretdb:/state -e FERRETDB_HANDLER=sqlite ghcr.io/ferretdb/ferretdb:1"
5 changes: 5 additions & 0 deletions runfile.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Runfile | https://crates.io/crates/runnables-cli

[dev]
alias = "d"
description = "starts all local dev services (db, core, periphery, ui) via mprocs"
cmd = "mprocs"

[dev-core]
alias = "dc"
description = "runs core --release pointing to .dev/core.config.toml"
Expand Down
Loading