完善README文档:添加项目介绍、功能说明和使用指南
This commit is contained in:
parent
73549335ab
commit
199785e1b0
44
README.md
44
README.md
@ -1,3 +1,45 @@
|
||||
# BookSystem
|
||||
|
||||
图书管理系统,可进行图书的管理和内容展示
|
||||
## 为什么想做这个项目
|
||||
最近计划做一个图书管理的系统,方便管理我的纸质图书和电子书,初衷是由于想看的书比较多,又分散在不同的平台,所以有时会忘记自己已经看了哪些书,已经买了哪些书,买的是电子书还是纸质书,以及电子书是在哪个平台购入的等等,所以想通过一个系统来管理,方便自己查看。正巧我的一个朋友是做文化传媒的,想做一个可以在线阅读的电子书平台,正好感觉可以做的到一起去,所以就有了这个项目。
|
||||
我觉得这个项目以开源的方式来做,因为这个项目做完后,不仅仅是一个图书的管理系统,其主要功能还是对信息的数字化管理,因此也可以用作于其他的信息管理,所以打算开源出来,希望可以帮到有需要的人。
|
||||
此外,这个项目也是我学习FastAPI和Vue的一个项目,所以打算用FastAPI和Vue来实现,FastAPI用来做后端,Vue用来做前端,通过前后端分离的方式,实现一个前后端分离的图书管理系统。之前也没有找到使用FastAPI实现的管理系统,正好借此机会边学习,边弥补这方面的空缺。
|
||||
这个项目之所以决定用python做,还有一个主要原因是,我想直接在项目中对接AI方面的功能,使用python对接起来更方便,还可以直接实现一些AI的算法,也算是我在AI方面的一个尝试。
|
||||
|
||||
## 项目介绍
|
||||
BookSystem是一个图书管理系统,用于管理纸质图书和电子书。它可以帮助用户记录自己已经看过的书,已经买的书,以及电子书是在哪个平台购入的等等。此外,它还可以用作于其他的信息管理,比如记录自己已经读过的文章,已经买的课程等等。
|
||||
|
||||
## 功能介绍
|
||||
本图书管理系统具有以下功能:
|
||||
- 管理纸质图书和电子书
|
||||
- 记录已经看过的书
|
||||
- 记录已经买的书
|
||||
- 记录电子书的购入平台
|
||||
- 电子书在线阅读
|
||||
|
||||
## 可能会实现的功能
|
||||
- AI推荐图书
|
||||
- 文章收藏
|
||||
- 文章在线阅读
|
||||
- AI推荐文章
|
||||
- AI朗读
|
||||
- AI写作
|
||||
- ...
|
||||
|
||||
## 项目结构
|
||||
- backend:后端代码
|
||||
- frontend:前端代码
|
||||
- README.md:项目介绍及使用说明
|
||||
- docker-compose: docker-compose文件
|
||||
- postgres_data:postgres数据库文件
|
||||
|
||||
## 使用说明
|
||||
1. 克隆项目到本地
|
||||
2. 使用docker-compose启动项目
|
||||
3. 访问前端页面
|
||||
- `http://localhost:8080`
|
||||
|
||||
## 注意事项
|
||||
- 本项目仅供学习和交流使用,请勿用于商业用途
|
||||
- 本项目中的数据均为模拟数据,请勿用于真实场景
|
||||
- 本项目仅个人开发学习使用,不保证系统稳定性,请谨慎使用
|
||||
Loading…
Reference in New Issue
Block a user