From 59caf96ee495f8d0528292a5e92f2a9ad2e3ed3b Mon Sep 17 00:00:00 2001 From: Melonai Date: Wed, 14 Jul 2021 19:54:07 +0200 Subject: Add README and specify Yarn as the package manager --- README.md | 31 +++++++++++++++++++++++++++++++ mix.exs | 2 +- 2 files changed, 32 insertions(+), 1 deletion(-) create mode 100644 README.md 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! diff --git a/mix.exs b/mix.exs index 5612043..19aa3de 100644 --- a/mix.exs +++ b/mix.exs @@ -53,7 +53,7 @@ defmodule Rook.MixProject do # See the documentation for `Mix` for more info on aliases. defp aliases do [ - setup: ["deps.get", "cmd npm install --prefix assets"] + setup: ["deps.get", "cmd cd assets; yarn"] ] end end -- cgit 1.4.1