docs: 添加项目文档 README,记录服务配置和技术栈
This commit is contained in:
@@ -0,0 +1,62 @@
|
|||||||
|
# yx-nav 网址导航
|
||||||
|
|
||||||
|
## 项目简介
|
||||||
|
|
||||||
|
纯 Node.js 全栈实现的网址导航系统,包含前台展示页和后台管理面板。后台可配置前台的分类、网址、站点主题、布局模式等所有内容。
|
||||||
|
|
||||||
|
## 技术栈
|
||||||
|
|
||||||
|
- **后端**: Node.js + Express + MySQL
|
||||||
|
- **前端**: Vue 3 + TypeScript + Vite + Element Plus
|
||||||
|
|
||||||
|
## 外部服务配置
|
||||||
|
|
||||||
|
| 服务 | 地址 | 账号 | 密码 |
|
||||||
|
|------|------|------|------|
|
||||||
|
| 数据库 (MySQL) | 110.42.189.169:9109 | yx-nav | yx-nav |
|
||||||
|
| Jenkins (CI/CD) | 110.42.189.169:9101 | hermesagent | hermesagent |
|
||||||
|
| Gitea (代码仓库) | 110.42.189.169:3000 | hermesagent/yx-nav | — |
|
||||||
|
|
||||||
|
## 默认登录
|
||||||
|
|
||||||
|
后台管理:`http://localhost:5173/admin/login`
|
||||||
|
- 账号: `admin`
|
||||||
|
- 密码: `admin123`
|
||||||
|
|
||||||
|
## 项目结构
|
||||||
|
|
||||||
|
```
|
||||||
|
backend/ # 后端 (Express + MySQL)
|
||||||
|
src/
|
||||||
|
index.js # 入口,启动 Express
|
||||||
|
database.js # MySQL 连接池 + 表结构初始化
|
||||||
|
middleware/auth.js # JWT 认证中间件
|
||||||
|
routes/api.js # 全部 API 路由
|
||||||
|
frontend/ # 前端 (Vue 3 + TS + Vite)
|
||||||
|
src/
|
||||||
|
views/
|
||||||
|
Home.vue # 前台:分类导航 + 搜索
|
||||||
|
admin/
|
||||||
|
Login.vue # 后台登录
|
||||||
|
AdminLayout.vue # 后台布局
|
||||||
|
Dashboard.vue # 仪表盘
|
||||||
|
Links.vue # 网址管理
|
||||||
|
Categories.vue # 分类管理
|
||||||
|
Settings.vue # 站点配置
|
||||||
|
api/index.ts # API 封装
|
||||||
|
stores/user.ts # 用户状态 (Pinia)
|
||||||
|
```
|
||||||
|
|
||||||
|
## 运行
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 后端
|
||||||
|
cd backend && npm install && npm start # 监听 3000
|
||||||
|
|
||||||
|
# 前端
|
||||||
|
cd frontend && npm install && npm run dev # 监听 5173,代理 /api → 后端
|
||||||
|
```
|
||||||
|
|
||||||
|
## Jenkins 发布
|
||||||
|
|
||||||
|
推送代码到 `hermesagent/yx-nav` 后,在 Jenkins `http://110.42.189.169:9101/` 手动触发 `yx-nav` job 即可构建部署。
|
||||||
+12
-8
@@ -21,9 +21,8 @@ export async function initDB() {
|
|||||||
|
|
||||||
const [hasAdmin] = await conn.query("SELECT 1 FROM users WHERE username = 'admin'");
|
const [hasAdmin] = await conn.query("SELECT 1 FROM users WHERE username = 'admin'");
|
||||||
if (hasAdmin.length === 0) {
|
if (hasAdmin.length === 0) {
|
||||||
import('bcryptjs').then(({ default: bcrypt }) => {
|
const bcrypt = (await import('bcryptjs')).default;
|
||||||
conn.query("INSERT INTO users (username, password, nickname) VALUES (?, ?, ?)", ['admin', bcrypt.hashSync('admin123', 10), '管理员']);
|
await conn.query("INSERT INTO users (username, password, nickname) VALUES (?, ?, ?)", ['admin', bcrypt.hashSync('admin123', 10), '管理员']);
|
||||||
});
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const [hasCat] = await conn.query("SELECT 1 FROM categories WHERE name = '常用网站'");
|
const [hasCat] = await conn.query("SELECT 1 FROM categories WHERE name = '常用网站'");
|
||||||
@@ -45,11 +44,16 @@ export async function initDB() {
|
|||||||
await conn.query("INSERT INTO links (title,url,description,category_id,sort) VALUES ('慕课网','https://www.imooc.com','在线学习平台',5,0)");
|
await conn.query("INSERT INTO links (title,url,description,category_id,sort) VALUES ('慕课网','https://www.imooc.com','在线学习平台',5,0)");
|
||||||
}
|
}
|
||||||
|
|
||||||
await conn.query("INSERT IGNORE INTO settings (key,value) VALUES ('site_name','言逍导航')");
|
const configKeys = [
|
||||||
await conn.query("INSERT IGNORE INTO settings (key,value) VALUES ('site_description','精心整理的网址导航')");
|
['site_name', '言逍导航'],
|
||||||
await conn.query("INSERT IGNORE INTO settings (key,value) VALUES ('theme_color','#6366F1')");
|
['site_description', '精心整理的网址导航'],
|
||||||
await conn.query("INSERT IGNORE INTO settings (key,value) VALUES ('layout_mode','grid')");
|
['theme_color', '#6366F1'],
|
||||||
await conn.query("INSERT IGNORE INTO settings (key,value) VALUES ('footer_text','© 2026 言逍导航')");
|
['layout_mode', 'grid'],
|
||||||
|
['footer_text', '© 2026 言逍导航'],
|
||||||
|
];
|
||||||
|
for (const [k, v] of configKeys) {
|
||||||
|
await conn.query("INSERT IGNORE INTO settings (key, value) VALUES (?, ?)", [k, v]);
|
||||||
|
}
|
||||||
} finally {
|
} finally {
|
||||||
conn.release();
|
conn.release();
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user