首先,克隆整个项目到本地:
git clone https://github.com/Bearisbug/SZU-Competition-Forum.git
cd SZU-Competition-Forum
前端使用 Node.js 和 npm 启动,确保你已经安装了 Node.js(包括 npm)。
进入前端项目目录:
cd FrontEnd
安装前端依赖:
执行以下命令来安装所有需要的前端依赖包:
npm install
这将根据 package.json
中列出的依赖来下载和安装所有所需的前端库。
启动前端开发服务器:
安装完依赖后,启动前端开发服务器:
npm run dev
默认情况下,前端项目将会在 localhost:3000
启动。打开浏览器并访问以下地址:
http://localhost:3000
你现在应该能够看到前端应用在浏览器中运行了。
后端使用 FastAPI ,在运行之前,请确保你已经安装了 Python(推荐使用虚拟环境)。
进入后端项目目录:
cd BackEnd
安装后端依赖:
执行以下命令来安装后端所需的 Python 库:
pip install -r requirements.txt
这将自动从 requirements.txt
文件中读取依赖并安装相应的包。
配置 FastAPI 启动脚本:
在配置 FastAPI 启动脚本之前,请单独运行 app.db.models 文件,他将会生成一份 .db 文件,此文件即为 SQLite 数据库,将这份文件放在启动与你的启动脚本同级的目录下面,并确保在启动之前,你已经安装了 Redis 数据库。
FastAPI 应用通常会有一个启动脚本(比如 main.py
),你需要确保在本地运行时能够启动 FastAPI。
确保安装了 uvicorn
,这是用于启动 FastAPI 应用的 ASGI 服务器:
pip install uvicorn
然后使用以下命令启动 FastAPI 后端:
uvicorn main:app --reload
main
是你的 FastAPI 应用所在的 Python 文件名(不带 .py
后缀)。app
是 FastAPI 实例化的对象,通常写作 app = FastAPI()
。--reload
选项表示开发模式下每次修改代码后自动重启服务器。启动后,你可以通过浏览器访问 http://localhost:8000
来访问后端 API,默认端口是 8000
。
确保前端和后端都已经成功启动后,整个项目就可以运行了:
http://localhost:3000
,访问前端页面。http://localhost:8000/docs
,访问后端 API 文档。确保前后端的接口能够正确连接。如果你在前端做了某些请求到后端,确保后端服务已经启动并且接口正确无误。