From d2153d76309fbfeda024a9e29454c90d10fb70ab Mon Sep 17 00:00:00 2001 From: david_bai Date: Tue, 26 Aug 2025 23:59:09 +0800 Subject: [PATCH] chore(doc):Update the doc on local development mode --- README.md | 5 +++-- README.zh-CN.md | 7 ++++--- frontend/.env_development_example | 2 +- 3 files changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 17c6812..060dcc3 100644 --- a/README.md +++ b/README.md @@ -41,11 +41,12 @@ We believe everyone should have control over their own data. PrivyDrop was creat Before you begin, ensure your development environment has [Node.js](https://nodejs.org/) (v18+), [npm](https://www.npmjs.com/), and a running [Redis](https://redis.io/) instance installed. -1. **Clone the Project** +1. **Clone the Project & install redis** ```bash git clone https://github.com/david-bai00/PrivyDrop.git cd PrivyDrop + sudo apt-get install -y redis-server ``` 2. **Configure and Start the Backend Service** @@ -66,7 +67,7 @@ Before you begin, ensure your development environment has [Node.js](https://node cd frontend pnpm install - # Copy the development environment file, then modify .env.development as needed + # Copy the development environment file, then modify .env.development as needed, Remove optional items cp .env_development_example .env.development pnpm dev # Starts by default at http://localhost:3002 diff --git a/README.zh-CN.md b/README.zh-CN.md index 992e33a..80552f1 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -41,11 +41,12 @@ PrivyDrop (原 SecureShare) 是一个基于 WebRTC 的开源点对点(P2P) 在开始之前,请确保你的开发环境已安装 [Node.js](https://nodejs.org/) (v18+), [npm](https://www.npmjs.com/) 以及一个正在运行的 [Redis](https://redis.io/) 实例。 -1. **克隆项目** +1. **克隆项目 & 安装 redis** ```bash git clone https://github.com/david-bai00/PrivyDrop.git - cd privydrop + cd PrivyDrop + sudo apt-get install -y redis-server ``` 2. **配置并启动后端服务** @@ -66,7 +67,7 @@ PrivyDrop (原 SecureShare) 是一个基于 WebRTC 的开源点对点(P2P) cd frontend pnpm install - # 复制开发环境变量文件,然后根据需要修改 .env.development + # 复制开发环境变量文件,然后根据需要修改 .env.development,删除可选项 cp .env_development_example .env.development pnpm dev # 默认启动于 http://localhost:3002 diff --git a/frontend/.env_development_example b/frontend/.env_development_example index 0ec99c6..c74e057 100755 --- a/frontend/.env_development_example +++ b/frontend/.env_development_example @@ -1,4 +1,4 @@ -NEXT_PUBLIC_API_URL=http://43.142.81.156:3001 +NEXT_PUBLIC_API_URL=http://localhost:3001 # Option,Delete if not needed NEXT_PUBLIC_TURN_HOST=43.142.81.156