From a01ca42353ed9748fc534a29c4d9f7c0b6d2f9b6 Mon Sep 17 00:00:00 2001
From: Karishma Shukla <carishmashukla28@gmail.com>
Date: Wed, 30 Oct 2024 11:02:56 +0530
Subject: [PATCH] chore: local setup

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

diff --git a/README.md b/README.md
index b8dbd9e6..f624a107 100644
--- a/README.md
+++ b/README.md
@@ -25,6 +25,29 @@ Maxun lets you train a robot in 2 minutes and scrape the web on auto-pilot. Web
 <img src="https://static.scarf.sh/a.png?x-pxid=c12a77cc-855e-4602-8a0f-614b2d0da56a" />
 
 # Installation
+### Docker
+
+### Local Setup
+1. Ensure you have Node.js, PostgreSQL, MinIO and Redis installed on your system.
+2. Run the commands below:
+```
+git clone https://github.com/getmaxun/maxun
+
+# change directory to the project root
+cd maxun
+
+# install dependencies
+npm install
+
+# change directory to maxun-core to install dependencies
+cd maxun-core 
+npm install
+
+# start frontend and backend together
+npm run start
+```
+You can access the frontend at http://localhost:5173/ and backend at http://localhost:8080/
+
 
 # Envirnoment Variables
 | Variable              | Mandatory | Description                                                                                  | If Not Set                                                   |