Skip to content

Commit 8e936a9

Browse files
committed
增加演示方式
1 parent 56ea79d commit 8e936a9

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,19 @@
66

77
# fast-tmp
88

9+
演示方式:
10+
通过docker拉镜像:
11+
12+
```shell
13+
sudo docker run -p 8000:8000 chise123/fast-tmp-example:v1.0.0
14+
```
15+
16+
然后访问```http://127.0.0.1:8000/admin```即可,
17+
超级用户的账户密码为```admin/123456```
918
项目模板
1019

1120
## 概述
21+
1222
本项目主要是方便快速构建fastapi的后端开发环境,依赖于```cookiecutter```,并提供方便快捷的生成路由的方法。
1323
主要使用的开发包:
1424

@@ -19,31 +29,44 @@
1929
整个项目在开发过程中参考了django的一些实现方式,尽量做到简洁明了。
2030

2131
## 安装fast-tmp
32+
2233
使用pip
34+
2335
```shell script
2436
pip3 install fast-tmp
2537
```
38+
2639
使用poetry
40+
2741
```shell script
2842
poetry add fast-tmp
2943
```
44+
3045
## 项目指令
46+
3147
目前包含的操作指令有两个:
48+
3249
1. 创建项目
3350
2. 创建超级用户
3451

3552
支持自定义指令并创建
3653

3754
### 创建项目
55+
3856
```shell script
3957
fast-tmp startproject
4058
```
59+
4160
输入完所需的参数之后,就可以生成一个自己的项目。
61+
4262
### 创建超级用户
63+
4364
创建超级用户需要使用了fast-tmp自带的models,
4465
首先,在项目.settings的TORTOISE_ORM里面配置fast-tmp的model
66+
4567
```python
4668
import os
69+
4770
TORTOISE_ORM = {
4871
'connections': {
4972
'default': {
@@ -65,18 +88,23 @@ TORTOISE_ORM = {
6588
}
6689
}
6790
```
91+
6892
然后,只需要执行:
93+
6994
```shell script
7095
fast-tmp createsuperuser
7196
```
97+
7298
### 自定义指令
7399

74100
在settings里面配置```EXTRA_SCRIPT```参数,就像配置django的参数一样,把脚本的相对导入路径写到这个字段列表里面,即可通过fast-tmp进行执行。
75101

76102
可以通过```fast-tmp --help```查看当前有哪些执行指令
77103

78104
## 功能
105+
79106
初始化项目之后,fast-tmp包里面有如下功能:
107+
80108
1. 全局settings管理
81109
2. crud生成器
82110

@@ -85,11 +113,15 @@ fast-tmp createsuperuser
85113
这个主要功能就是在所有地方都是通过```fast_tmp.conf.settings```获取设置值或环境变量。
86114

87115
具体使用如下:
116+
88117
```python
89118
from fast_tmp.conf import settings
119+
90120
...
91121
```
122+
92123
## 联系
124+
93125
欢迎各位pythoner到这里来沟通
94126
qq群: 142289799
95127
![142289799](./docs/images/qq群.jpg)

0 commit comments

Comments
 (0)