Skip to content

docs(readme_en): 修复照做即失败的 Windows 命令与 .env 文件引用 #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hailuohl wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −8
Open

docs(readme_en): 修复照做即失败的 Windows 命令与 .env 文件引用 #117

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README_EN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,13 +129,12 @@ Three deployment options are available, choose the one that suits you best:
1. Configure Environment Variables

```bash
cp backend/.env.dev.example backend/.env.dev
cp frontend/.env.example frontend/.env.development
cp backend/.env.example backend/.env.dev
```

Fill in the configuration in:
- backend/.env.dev
- frontend/.env.development
- frontend/.env.development (already in the repo, edit it directly)

2. Start Services

Expand All @@ -155,13 +154,13 @@ You can now access:

1. Configure Environment Variables

Copy `/backend/.env.dev.example` to `/backend/.env.dev` (remove the `.example` suffix)
Copy `/backend/.env.example` to `/backend/.env.dev` (remove the `.example` suffix)

**Configure Environment Variables**

It is recommended to use models with strong capabilities and large parameter counts.

Copy `/frontend/.env.example` to `/frontend/.env.development` (remove the `.example` suffix)
Edit `/frontend/.env.development` directly (the file is already in the repo)

2. Install Dependencies

Expand All @@ -182,11 +181,12 @@ uv sync # Install dependencies
# Start backend
# Activate Python virtual environment
source .venv/bin/activate # MacOS or Linux
venv\Scripts\activate.bat # Windows
.venv\Scripts\activate.bat # Windows (uv sync creates .venv)
# Run this command for MacOS or Linux
ENV=DEV uvicorn app.main:app --host 0.0.0.0 --port 8000 --ws-ping-interval 60 --ws-ping-timeout 120 --reload
# Run this command for Windows
set ENV=DEV ; uvicorn app.main:app --host 0.0.0.0 --port 8000 --ws-ping-interval 60 --ws-ping-timeout 120
# Run these commands for Windows (cmd does not treat ';' as a command separator)
set ENV=DEV
uvicorn app.main:app --host 0.0.0.0 --port 8000 --ws-ping-interval 60 --ws-ping-timeout 120 --reload
```

Start frontend
Expand Down