Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/datawhalechina/wow-fullstack

wow-fullstack,令人惊叹的全栈开发教程
https://github.com/datawhalechina/wow-fullstack

element fastapi typescript vue3 wow

Last synced: about 1 month ago
JSON representation

wow-fullstack,令人惊叹的全栈开发教程

Awesome Lists containing this project

README

        

# wow-全栈

好的教程可以一路运行。
我们要做一个能够一路拷贝代码运行的全栈开发教程。集成了许多优秀代码片段,在开发过程中可以随时复制。同时搭配了一个练手项目,一个用来做时间管理的项目。前端采用ts+vue3+vite架构,后端采用fastapi架构。开源项目和开源教程可以打配合。开源项目里用到的知识写入开源教程。开源教程所用到的例子来源于开源项目。互相印证。

# 教程使用方法

- TS:进入tutorial文件夹,再进入[TypeScript](https://github.com/datawhalechina/wow-fullstack/tree/main/tutorial/TypeScript)文件夹,自行阅读各个章节。文档都是Markdown,点开后可直接阅读。代码的输出结果已经写在相应代码下方了。需要什么代码尽管拷贝。
- Vue3:进入tutorial文件夹,再进入[Vue3](https://github.com/datawhalechina/wow-fullstack/tree/main/tutorial/Vue3)文件夹,自行阅读各个章节。文档都是Markdown,点开后可直接阅读。代码的输出结果已经写在相应代码下方了。需要什么代码尽管拷贝。
- FastAPI:进入tutorial文件夹,再进入[FastAPI](https://github.com/datawhalechina/wow-fullstack/tree/main/tutorial/FastAPI)文件夹。文档都是jupyter notebook,需要把ipynb文件下载到本地去运行。直接运行每个代码格子就可以。

# 前后端使用方法

首先如果是首次拉取代码,用git clone https://github.com/datawhalechina/wow-fullstack.git ,把所有代码拉取下来。如果以前有拉取过,就用git pull

### 确保版本正确
python需要的版本是3.10
node需要的版本是v18.18.0
npm需要的版本是10.2.5
### 安装后端依赖库
进入`tm-backend`文件夹,确保`requirement.txt`文件是在的,然后
`pip install -r requirement.txt`
### 生成数据库
如果根目录有`mydatabase.db`这个文件,其实是可以直接输入命令 `python main.py` 启动后端的,不过出于教学的目的,我们可以先把这个文件删掉,重新生成一遍。
在`alembic.ini`所在的文件夹所在的cmd窗口输入命令创建迁移脚本:
`alembic revision --autogenerate -m "my first db"`
这将在`alembic/versions` 目录下创建一个新的迁移脚本,打开脚本,确认一下upgrade函数有没有问题,是不是想要的变更?如果没问题就输入
`alembic upgrade head`
在根目录下会看到mydatabase.db这个数据库文件。这样数据库就建好了。但是数据表里还没有数据

### 填充测试数据
可以填写一些假数据,方便测试
在cmd窗口输入 `python seed.py` 即可。
这个seed.py的作用是新建一下static文件夹以及下面的profiles文件夹,然后在数据库填充管理员的账号。
运行完python seed.py可以看看mydatabase.db这个数据库文件是不是更新了,有数据了。
查看sqlite数据库可以到https://sqlitebrowser.org/ 下载一个DB Browser for SQLite这样就可以用可视化的图形界面查看sqlite数据库里的数据了。

### 测试填充数据
在cmd窗口输入 `python check_password.py` 即可。如果后端输出了
自塾
True
说明运行正确。数据库中的数据库有效。就不需要再去管seed.py。seed.py已经完成了它的历史使命。

### 启动后端
在main.py 所在的文件开启cmd窗口,输入命令 python,查看是否是python3.10 版本?如果版本不对,请自行解决python版本问题。
版本正确后,输入命令 `python main.py` 即可启动后端。

### 测试后端是否正常运行

浏览器中输入 http://127.0.0.1:8008 看是否能出现 {"Hello":"World"} ?
浏览器中输入 http://127.0.0.1:8008/docs 看是否能出现 FastAPI 各种post、get接口文档?
如果两个都没问题,就说明后端一切正常。

### 启动前端
node需要的版本是v18.18.0
npm需要的版本是10.2.5
进入 tm-fronfend,输入命令 npm install
如果出现报错可尝试删除package-lock.json项目
如果运行顺利,输入 npm run dev
如果顺利,会输出浏览器链接,不要用localhost:5173。我们找一个 192.168 的贴到浏览器,就可以打开页面了。
打开前端页面后,点右上角的登录按钮,输入手机号15812345678,密码 zishu,即可进入网站。

## 参与贡献

本项目由[自塾](https://zishu.co/v1/tw/article/121)团队负责维护。

- 如果你想参与到项目中来欢迎查看项目的 [Issue]() 查看没有被分配的任务。
- 如果你发现了一些问题,欢迎在 [Issue]() 中进行反馈🐛。
- 如果你对本项目感兴趣想要参与进来可以通过 [Discussion]() 进行交流💬。

如果你对 Datawhale 很感兴趣并想要发起一个新的项目,欢迎查看 [Datawhale 贡献指南](https://github.com/datawhalechina/DOPMC#%E4%B8%BA-datawhale-%E5%81%9A%E5%87%BA%E8%B4%A1%E7%8C%AE)。

## 贡献者名单

需要开发的产品和对应的大写首字母有:
1.时间管理课程 Course
2.技术教程 Tutorial
3.用户使用指南 Guide
4.开发文档 Docs
5.前端代码 Frontend
6.后端代码 Backend

开发者需要根据自己的技能和兴趣选定一个开发产品作为主产品。
目前的开发人员安排:
Course:[Susan](https://github.com/Susan2048)
Tutorial:[Hoshino-wind](https://github.com/Hoshino-wind)、[KMnO4-zx](https://github.com/KMnO4-zx)
Guide:张某 、[WuXiaoMing](https://xlight5.github.io)
Docs:[Kailigithub](https://github.com/Kailigithub) 、[WuXiaoMing](https://xlight5.github.io)
Frontend:[lime](https://github.com/yyhhxx) 、[WuXiaoMing](https://xlight5.github.io)
Backend:[Tom.Yang](https://github.com/7n8fail)、[lish](https://github.com/kevin-light)、[wu](https://github.com/AIzealotwu) 、[WuXiaoMing](https://xlight5.github.io)

## 关注我们


扫描下方二维码关注公众号:Datawhale



## LICENSE

知识共享许可协议
本作品采用MIT进行许可。

*注:默认使用CC 4.0协议,也可根据自身项目情况选用其他协议*