diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..b8f5147 --- /dev/null +++ b/README.md @@ -0,0 +1,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! |
