From b79ef79b1fff0c96ae453678359f17266fc1b626 Mon Sep 17 00:00:00 2001
From: liamcottle <liam@liamcottle.com>
Date: Thu, 8 Aug 2024 10:38:10 +1200
Subject: [PATCH] update docs

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/README.md b/README.md
index bee10f6..37f77fd 100644
--- a/README.md
+++ b/README.md
@@ -254,6 +254,31 @@ npm run dist
 
 Once completed, you should have a `.exe` or a `.dmg` in the `dist` folder.
 
+## Local Development
+
+I normally run the following commands to work on the project locally.
+
+**Install dependencies**
+
+```
+pip install -r requirements.txt
+npm install
+```
+
+**Build Vite App**
+
+```
+npm run build
+```
+
+**Run MeshChat Server**
+
+```
+python3 meshchat.py --headless
+```
+
+I build the vite app everytime without hot reload, since MeshChat expects everything over its own port, not the vite server port. I will attempt to fix this in the future.
+
 ## TODO
 
 - [ ] contact management to save identity, addresses, custom name and notes