search

caolan / mutiny

Peer-to-peer web applications runtime
5 stars 1 forks source link

readme

Mutiny

Peer-to-peer web applications runtime.

Structure

Usage

First, run the daemon:

cd mutinyd
cargo run

Then, run mutiny to check communication between daemon and CLI:

./mutiny/mutiny serve chat ./examples/chat

Help

mutinyd

Runtime for peer-to-peer web apps

Usage: mutinyd [OPTIONS]

Options:
  -s, --socket <SOCKET>  Unix socket to bind to
  -d, --data <DATA>      Local peer's data directory
  -h, --help             Print help
  -V, --version          Print version

Running multiple instances

For testing, it can be useful to run multiple instances of mutinyd on the same machine. To do so, set a custom socket path and data directory:

cd mutinyd
cargo run -- --socket ./mutiny2.sock --data ./data2

You can then run apps on your additional instance using the --socket option:

./mutiny/mutiny serve --socket ./mutinyd/mutiny2.sock chat ./examples/chat

Examples

Ping

Demonstrates communication between frontend, mutiny HTTP server, and mutinyd daemon.

First, start the mutinyd daemon:

cd mutinyd
cargo run

Then, serve the app:

./mutiny/mutiny serve ping examples/ping

And open the displayed URL in your browser. You should see your local peer ID at the top of the page and a (potentially empty) list of discovered peers below. Repeating this process on another machine on your local network will hopefully add a discovered peer to the list.

Chat

Demonstrates peer-to-peer message delivery on the local network.

First, start the mutinyd daemon:

cd mutinyd
cargo run

Then, serve the app:

./mutiny/mutiny serve chat examples/chat

And open the displayed URL in your browser. Repeat this process on another machine on your local network and it will hopefully add a discovered peer to the list on the left. Click on the peer to type messages to each another.

Tests

Integration

Integration tests can be found in the top tests directory - these exercise multiple programs and test the interation between them.

cd tests
deno test -A

mutinyd

Unit tests for the mutiny daemon:

cd mutinyd
cargo test

mutiny

Unit tests for the mutiny server:

cd mutiny
deno test -A

Documentation