about summary refs log tree commit diff
path: root/README.md
blob: b8f5147dcbf039de6c20f947d36b06d2478e3c70 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# ♜ Rook

Secure secret and file sharing using WebRTC.

### Running locally

Before starting please ensure that you have both [Elixir](https://elixir-lang.org/install.html) and [Yarn](https://classic.yarnpkg.com/en/docs/install/) installed.

To quickly set up all dependencies needed by both the server and the client run:

```sh
$ mix setup
```

To then run the app, run either:

```sh
$ mix phx.server
```

or

```sh
$ iex -S mix phx.server
```

to get an interactive IEx session.

---

Have fun!