Skip to content
This repository was archived by the owner on Jan 7, 2026. It is now read-only.

Commit 9a239bf

Browse files
authored
docs: add readme (#13)
1 parent 49d1056 commit 9a239bf

File tree

1 file changed

+20
-58
lines changed

1 file changed

+20
-58
lines changed

README.md

Lines changed: 20 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,37 @@
1-
# Nuxt Minimal Starter
1+
# Video Hub
22

3-
Look at the [Nuxt documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
3+
**Video Hub** 是 AdFlux 项目的视频网站部分。
44

5-
## Setup
5+
## 核心架构
66

7-
Make sure to install dependencies:
7+
本项目基于 **Nuxt.js** 框架开发,实现了前后端全栈式统一架构。
88

9-
```bash
10-
# npm
11-
npm install
12-
13-
# pnpm
14-
pnpm install
15-
16-
# yarn
17-
yarn install
18-
19-
# bun
20-
bun install
21-
```
22-
23-
## Development Server
24-
25-
Start the development server on `http://localhost:3000`:
26-
27-
```bash
28-
# npm
29-
npm run dev
9+
- **前端/后端**:Nuxt.js (Vue 3 + Nitro)
10+
- **数据库**:PostgreSQL
3011

31-
# pnpm
32-
pnpm dev
12+
## 构建与部署
3313

34-
# yarn
35-
yarn dev
14+
本项目已接入 **GitHub Actions** 实现自动化 CI/CD 流程。
3615

37-
# bun
38-
bun run dev
39-
```
16+
- **自动化构建**:每次提交将自动触发 [Workflow](https://github.com/USST-JavaWeb-251-AdFlux/Video-FullStack/actions/workflows/release.yml) 构建 Docker 镜像。
17+
- **获取产物**:你可以在 [Releases](https://github.com/USST-JavaWeb-251-AdFlux/Video-FullStack/releases) 页面下载预构建完成的产物(压缩包内包含 `docker-compose.yml``video-app.tar.gz` 镜像包)。
4018

41-
## Production
19+
## 本地开发
4220

43-
Build the application for production:
21+
若需在开发环境下运行项目,请执行以下指令:
4422

4523
```bash
46-
# npm
47-
npm run build
24+
# 安装依赖
25+
$ pnpm i
4826

49-
# pnpm
50-
pnpm build
27+
# 启动开发服务器
28+
$ pnpm dev
5129

52-
# yarn
53-
yarn build
54-
55-
# bun
56-
bun run build
5730
```
5831

59-
Locally preview production build:
60-
61-
```bash
62-
# npm
63-
npm run preview
64-
65-
# pnpm
66-
pnpm preview
32+
## 环境变量配置
6733

68-
# yarn
69-
yarn preview
70-
71-
# bun
72-
bun run preview
73-
```
34+
应用运行所需的变量配置详见 `.env.example`,请将其拷贝为 `.env` 后按需调整。
7435

75-
Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
36+
- **Docker 部署**:若使用 Docker Compose 运行,请参考 `docker-compose.yml` 中的 `environment` 字段进行配置。
37+
- **安全提示**:由于 Docker 在构建(Build)阶段会将当前的 `.env` 文件打入镜像,请务必确保构建环境中不包含敏感信息(如生产环境数据库密码、JWT Secret 等)。建议通过容器运行时(Runtime)注入环境变量。

0 commit comments

Comments
 (0)