From 4458954cc13d18c405e67953c023671e5e4ce61f Mon Sep 17 00:00:00 2001
From: Ludovic Mermod <ludovic.mermod@epfl.ch>
Date: Wed, 11 Sep 2024 09:21:10 +0200
Subject: [PATCH] docs: add basic dev instructions

---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1973c9e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# CLIC x S4S - 2024
+
+## Dev
+
+### Dependencies
+
+You will need the following dependencies:
+
+- [Rust](rustup.rs)
+- [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
+- [docker](https://www.docker.com/get-started/)
+
+## Set up environment files
+
+In `app/.env`, put:
+
+```sh
+NEXT_PUBLIC_FRONTEND_URL=http://localhost:3000/s4s
+NEXT_PUBLIC_API_URL=http://localhost:8000
+```
+
+## Run locally
+
+From the `app` directory, run `npm i &&NEXT_PUBLIC_API_URL=http://localhost:8000 npm run dev` in your terminal. In parallel, run `mkdir -p data &&DATA_DIR=$PWD/data cargo r` from the `backend` directory.
+
+Now, you can access the website on <http://localhost:3000/s4s>.