From b1de1e390cd2b9053d959950b39239e9ad2a49f8 Mon Sep 17 00:00:00 2001
From: Daniel Heidemann <mail@dheidemann.de>
Date: Fri, 19 Jul 2024 00:55:09 +0200
Subject: [PATCH] update root readme

---
 README.md | 21 ++++++++++++++++++---
 1 file changed, 18 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 5e63587..8862533 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,25 @@
 # pepp
-## dev ([todos](https://github.com/FachschaftMathPhysInfo/pepp/issues/1))
+> **P**raktische **E**rsti-**P**rogramm**p**lanung
+
+## build
 1. `cp .env .env.local`
 2. `docker compose build`
 3. `docker compose up -d && docker compose logs -f`
 
-The API is now reachable on `localhost:8080/api`.
-Documentation for all endpoints can be found in the `README.md` inside `server/`. Messing around with the API is possible via the GraphQL Playground on `localhost:8080`.
+- Frontend: [localhost:8080](http://localhost:8080)
+- API: [localhost:8080/api](http://localhost:8080/api)
+- GraphQL Playground: [localhost:8080/playground](http://localhost:8080/playground)
+  - Documentation for all endpoints can be found in the [`server/README.md`](server/README.md)
+
+### dev
+#### frontend
+1. `cd frontend`
+2. `npm i`
+3. `npm run dev`
+
+#### backend
+
+i just rebuild the docker image on change
 
 For the E-Mail verification to work you have to provide a smtp server inside your `.env.local`, e.g.:
 ```
@@ -15,6 +29,7 @@ SMTP_PASSWORD=1234
 SMTP_PORT=465
 FROM_ADDRESS=vorkurs@example.de
 ```
+
 ## contributions
 1. [create an issue](https://github.com/FachschaftMathPhysInfo/pepp/issues/new)
 2. from this issue create a branch and work on it