Skip to content

Commit 1e5daef

Browse files
authored
Enhance README with local running guide
Added detailed local setup instructions and troubleshooting tips.
1 parent 9cad825 commit 1e5daef

1 file changed

Lines changed: 58 additions & 3 deletions

File tree

README.md

Lines changed: 58 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,59 @@
11
# Turtle Universe Web
2-
使用php进行搭建,可以实现更多之前不可能实现的功能.
3-
如:本地存档(把用户的存档放在ftp服务器上,php可以调用,编辑和删除)
4-
测试:https://tuweb.page.gd/
2+
海龟实验室(Turtle Universe)的网页版本,使用 PHP 构建。
3+
4+
## 在线测试
5+
您可以直接访问已部署的在线版本进行体验:
6+
[https://tuweb.page.gd/](https://tuweb.page.gd/)
7+
8+
## 本地运行详细指南
9+
请按顺序完成以下步骤,即可在您的电脑上成功运行本项目。
10+
11+
### 第一步:检查并安装 PHP
12+
1. **打开终端**(Windows:CMD 或 PowerShell;Mac/Linux:终端)。
13+
2. **输入以下命令检查是否已安装 PHP 及版本**
14+
`php -v`
15+
3. **查看结果**
16+
* 如果显示了类似 `PHP 7.4.x``PHP 8.x.x` 的版本信息,说明已安装,请跳至第二步。
17+
* 如果显示“找不到命令”或版本低于 7.4,则需要安装。
18+
4. **安装 PHP**
19+
* **Windows**:访问 [php.net/downloads](https://www.php.net/downloads) 下载“Non Thread Safe”版本的 ZIP 包,解压后,将 `php.exe` 所在文件夹路径(如 `C:\php\`)添加到系统的**环境变量 PATH** 中。
20+
* **Mac**:可使用 Homebrew 安装:`brew install php@8.1`
21+
* **Linux (Debian/Ubuntu)**:使用 apt:`sudo apt update && sudo apt install php`
22+
23+
### 第二步:获取项目文件
24+
您可以选择以下任一方式:
25+
* **方式一(推荐,使用 Git)**:在您想存放项目的文件夹中打开终端,运行:
26+
`git clone <您的项目仓库地址>`
27+
* **方式二(直接下载)**:从项目仓库页面直接下载 ZIP 压缩包,然后在本地解压。
28+
29+
### 第三步:启动本地 PHP 服务器
30+
1. 在终端中,**进入**您刚下载的项目根目录。例如:
31+
`cd /path/to/your/turtle-universe-web`
32+
*小技巧:在文件夹空白处按住 Shift 键并点击鼠标右键,可选择“在此处打开终端/命令窗口”。*
33+
2. 在项目根目录下,**执行启动命令**
34+
`php -S localhost:8080`
35+
3. 如果成功,终端将显示类似以下信息:
36+
`PHP 7.4.3 Development Server started at http://localhost:8080`
37+
38+
### 第四步:在浏览器中访问
39+
1. 打开您的浏览器(如 Chrome, Firefox, Edge)。
40+
2. 在地址栏输入终端中显示的地址:
41+
`http://localhost:8080`
42+
3. 按下回车,您应该就能看到和在线测试网站一样的 Turtle Universe Web 界面了。
43+
44+
### 第五步:停止服务器
45+
当您想停止本地服务器时,只需回到启动它的那个终端窗口,按下键盘快捷键:
46+
`Ctrl + C`
47+
48+
---
49+
50+
## 常见问题排查
51+
* **访问 `http://localhost:8080` 显示“无法连接”或白屏**
52+
* 请确认第三步的服务器是否成功启动(终端有无错误信息)。
53+
* 请确认浏览器地址栏输入的是 `http://localhost:8080`,而不是 `https`
54+
* **页面显示 PHP 代码或出现下载提示**
55+
* 说明 PHP 没有正常运行,请返回第一步仔细检查 PHP 安装和环境变量。
56+
* **页面样式错乱或功能不全**
57+
* 可能是资源加载路径问题,请确保通过 `http://localhost:8080` 访问,且服务器是从项目**根目录**启动的。
58+
59+
按照以上步骤操作,您应该可以顺利在本地运行项目。如果遇到其他问题,请提供终端或浏览器显示的具体错误信息,并提交至issue。

0 commit comments

Comments
 (0)