Skip to content

Commit 1c9577d

Browse files
committed
docs: 增加演示站点运行说明并同步英文文档
1 parent 6637a77 commit 1c9577d

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,22 @@
165165
poetry run python manage.py runserver
166166
```
167167
168+
## 🕹️ 运行演示站点
169+
170+
您也可以切换到 `demo` 分支,运行我们提供的演示站点,查看项目效果,该分支已经构建好了前端资源,且包含样例媒体文件和数据库文件。
171+
172+
(如果无法切换到 `demo` 分支,请确保您已存储当前更改,您可以直接暂时删除自动创建的 `files` 和 `db.sqlite3` 然后重试)
173+
174+
```bash
175+
git chekout demo
176+
```
177+
```bash
178+
poetry install --no-root
179+
```
180+
```bash
181+
poetry run python manage.py runserver
182+
```
183+
168184
## ⚙ 后端配置
169185

170186
可通过编辑 `connectClub/settings.py` 来修改,或设置以 `CONNECT_CLUB_` 开头的环境变量设置部分配置

README_en.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,22 @@ Below are screenshots of the application. Click any thumbnail to open the full i
161161
poetry run python manage.py runserver
162162
```
163163

164+
## 🚀 Run the demo site
165+
166+
You can switch to the `demo` branch to run the provided demo site and see the project in action. This branch already includes built frontend assets and sample media and database files.
167+
168+
(If you cannot switch to the `demo` branch, make sure you have saved your current changes. You can temporarily delete the automatically created `files` directory and `db.sqlite3` then try again.)
169+
170+
```bash
171+
git checkout demo
172+
```
173+
```bash
174+
poetry install --no-root
175+
```
176+
```bash
177+
poetry run python manage.py runserver
178+
```
179+
164180
## ⚙ Backend configuration
165181

166182
You can modify settings in `connectClub/settings.py` or set environment variables prefixed with `CONNECT_CLUB_` for some configuration options.

0 commit comments

Comments
 (0)