From 4c2bfb95e32e90130160971615c1a07f4b0c6fdc Mon Sep 17 00:00:00 2001
From: Mauricio Siu <47042324+Siumauricio@users.noreply.github.com>
Date: Wed, 1 May 2024 00:04:20 -0600
Subject: [PATCH] chore: update instructions to run the project properly

---
 CONTRIBUTING.md | 30 +++++++++++++++++++++++++-----
 1 file changed, 25 insertions(+), 5 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 8d0a2d44..06467b18 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -51,10 +51,12 @@ feat: add new feature
 
 ## Setup
 
+We use Node `18.18.0` and pnpm `8.15.4` to run the project.
+
 ```bash
 git clone https://github.com/dokploy/dokploy.git
 cd dokploy
-npm install
+pnpm install
 cp .env.example .env
 ```
 
@@ -62,28 +64,46 @@ cp .env.example .env
 
 Is required to have **Docker** installed on your machine.
 
+
+### Setup
+
+We need to create the file system of dokploy and give the permissions.
+
 ```bash
-npm run dev
+sudo mkdir -p /etc/dokploy && sudo chmod 777 /etc/dokploy
 ```
 
+Now we can run the command that will spin up all the required services and files.
+
+```bash
+pnpm run setup
+```
+
+Now run the development server.
+
+```bash
+pnpm run dev
+```
+
+
 Go to http://localhost:3000 to see the development server
 
 ## Build
 
 ```bash
-npm run build
+pnpm run build
 ```
 
 ## Docker
 
 To build the docker image
 ```bash
-npm run docker:build
+pnpm run docker:build
 ```
 
 To push the docker image
 ```bash
-npm run docker:push
+pnpm run docker:push
 ```
 
 ## Password Reset