# fastapi-template

**Repository Path**: i37ck/fastapi-template

## Basic Information

- **Project Name**: fastapi-template
- **Description**: fastapi项目简易模板
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 3
- **Created**: 2024-09-26
- **Last Updated**: 2024-09-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# fastapi-template

## 介绍
fastapi项目简易模板

<br />

## 目录结构

```tex
├── controller                            controller控制层
│    ├── user_controller
│    └── ...
├── db                                    sql脚本存放目录
│    ├── 1.0.0                            按版本号归档
│    │    └── user.py
│    └── ...
├── lib                                   相关辅助/工具类
│    ├── logging_helper.py                日志配置类
│    ├── mysql_helper.py                  mysql辅助类
│    └── utils.py                         常用函数
├── logs                                  日志存放目录
│    └── ...
├── model                                 model实体层
│    ├── base.py                          ORM基础类/业务基础类
│    ├── error.py                         自定义异常相关
│    ├── user.py
│    └── ...
├── service                               service业务服务层
│    └── ...
├── sql                                   dao数据访问层
│    ├── user_dao.py
│    └── ...
├── .gitignore                            git忽略文件
├── main.py                               入口文件
├── README.md                             项目说明
├── requirements.py                       项目依赖说明
└── setting.py                            配置文件
```

项目中`user`、`account`相关内容为示例代码，进行开发时请删除

<br />

## 启动项目

### 虚拟环境启动

#### 1.安装依赖

```python
pip install -r requirements.txt
```

#### 2.运行项目

```python
python main.py
# 后台运行
nohup python main.py > /dev/null 2>&1 &
```

<br />

### docker启动

项目目录：`/data/container/fastapi-template`

#### 1.构建镜像

```shell
docker build -t fastapi-template:latest .
```

注意最后的点（当前文件夹）

#### 2.docker-compose运行

```shell
docker-compose up
# 后台运行
docker-compose up -d
```