chore: update instructions to run the project properly

This commit is contained in:
Mauricio Siu
2024-05-01 00:04:20 -06:00
parent 69122573aa
commit 4c2bfb95e3

View File

@@ -51,10 +51,12 @@ feat: add new feature
## Setup ## Setup
We use Node `18.18.0` and pnpm `8.15.4` to run the project.
```bash ```bash
git clone https://github.com/dokploy/dokploy.git git clone https://github.com/dokploy/dokploy.git
cd dokploy cd dokploy
npm install pnpm install
cp .env.example .env cp .env.example .env
``` ```
@@ -62,28 +64,46 @@ cp .env.example .env
Is required to have **Docker** installed on your machine. Is required to have **Docker** installed on your machine.
### Setup
We need to create the file system of dokploy and give the permissions.
```bash ```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 Go to http://localhost:3000 to see the development server
## Build ## Build
```bash ```bash
npm run build pnpm run build
``` ```
## Docker ## Docker
To build the docker image To build the docker image
```bash ```bash
npm run docker:build pnpm run docker:build
``` ```
To push the docker image To push the docker image
```bash ```bash
npm run docker:push pnpm run docker:push
``` ```
## Password Reset ## Password Reset