readme editted (#42)

* readme editted * resolvedcommit --------- Co-authored-by: Aram Leblebjian <[email protected]>
Mgrdich · May 11, 2024 · 2ba4d99 · 2ba4d99
1 parent c30e355
commit 2ba4d99
Showing 1 changed file with 12 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,14 @@
-# LLM Service 
-
-Run your LLM service Locally
-
-## how to run it locally
+# The Steps to Run the LLM service Locally
 
 * First download gguf from https://huggingface.co/TheBloke/Llama-2-13B-chat-GGUF , `llama-2-13b-chat.Q5_K_S.gguf`
-* move this model to `model/llama-2-13b-chat.Q5_K_S.gguf`
+* move this model to `model/llama-2-13b-chat.Q5_K_S.gguf`
+* to locally develop the frontend, you need to:
+    1. Navigate to the frontend directory: `cd frontend`
+    2. Install PNPM: `npm install -g pnpm`
+    3. Install Dependencies: `npm start`
+    4. start the application in dev mode: `pnpm dev`
+    5. production build: `pnpm build`
+
+# To run the backend
+* run docker containers: docker-compose up -d
+* after making sure that the database and the frontend are running, run the LlmServiceApplication