Skip to content

Commit

Permalink
Merge pull request #29 from Moujuruo/new_readme
Browse files Browse the repository at this point in the history
update README
  • Loading branch information
Moujuruo authored Jun 9, 2024
2 parents 8ae04fc + ac0af0f commit a7e8e8b
Showing 1 changed file with 25 additions and 5 deletions.
30 changes: 25 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ python 推荐使用虚拟环境,我使用的是 3.8 版本

## 启动

1. 在安装好flask的环境下进入`backend`目录启动后端:`python run.py`
1. 在安装好flask的环境下不要进入`backend`目录启动后端:`python backend/run.py`
2. 进入`frontend`目录启动前端:`npm start` (第一次启动需要先`npm install`

## 前端部分
Expand All @@ -24,13 +24,27 @@ python 推荐使用虚拟环境,我使用的是 3.8 版本
代码结构是:

- src
- css
- editor.css:笔记编辑器的样式
- App.tsx: 基本的路由配置
- pages
- MainLayout.tsx: 主要的布局文件,包含了侧边栏和头部,切换的路由管理也要记得加在这里
- Login.tsx: 登录页面
- HomePage.tsx: 主页
- Login
- Login.tsx: 登录页面
- Register.tsx: 注册页面
- HomePage 主页
- HomePage.tsx: 主页
- LeftTopSection.tsx: 主页左上块
- RightTopSection.tsx: 主页右上块
- NotePage.tsx: 笔记页面
- TodoList.tsx: 日程表功能
- InfoDialog.tsx: 插入日程表的弹窗,应该和上一个文件放在一个文件夹下(todo),还没用 ProComponents 重写
- InfoDialog.tsx: 插入日程表的弹窗
- Reservation
- MyReservation.tsx: 我的预约
- ReservationModal.tsx: 预约弹窗
- ReservationPage.tsx: 预约页面
- RoomInfoToolTips.tsx: 房间信息提示
- Team 团队页面(todo:只实现了基本功能)
- router
- ProtectedRoute.tsx: 保护路由,未登录时跳转到登录页面
- utils
Expand All @@ -41,4 +55,10 @@ python 推荐使用虚拟环境,我使用的是 3.8 版本

## 后端部分

flask 后端框架,较为简单,就两个文件看看就懂了
flask 后端框架,todo:需要重构部分代码,目前较冗余
`run_app.py`为启动文件,其余均为模块文件

## 数据库

使用 sqlite 数据库,建库脚本见后端各模块。测试用的数据库为 `Ai_work.db`

0 comments on commit a7e8e8b

Please sign in to comment.