Ignite 开源项目教程

Ignite 开源项目教程

Ignite A comprehensive Flask boilerplate to build SaaS applications that includes Stripe billing, emails, login, and OAuth. 项目地址: https://gitcode.com/gh_mirrors/ignite1/Ignite

1. 项目目录结构及介绍

Ignite 是一个为 Flask 应用程序提供的综合性的脚手架，它包含了用户认证、OAuth 登录、团队管理、账单处理等功能的 boilerplate 代码。以下是项目的目录结构及各部分功能的简要介绍：

.
├── .gitignore                # Git 忽略文件列表
├── .github                   # GitHub 相关配置
├── .vscode                   # VSCode 编辑器配置
├── appname                   # 应用名称配置
├── docker                    # Docker 部署配置
├── documentation             # 项目文档
├── migrations                # 数据库迁移脚本
├── tests                     # 测试用例
├── tmp                       # 临时文件
├── .coveragerc               # 代码覆盖率配置
├── .env.local.sample         # 环境变量样本文件
├── CHECKS                    # 部署检查脚本
├── LICENSE.md                # 许可证文件
├── Makefile                  # Makefile 文件
├── Procfile                  # Heroku 部署的进程文件
├── README.md                 # 项目说明文件
├── app.json                  # 应用配置文件
├── manage.py                 # 管理脚本
├── requirements.txt          # 项目依赖文件
├── runtime.txt               # 运行时依赖文件
├── setup.cfg                 # 设置配置文件
├── wsgi.py                   # WSGI 应用启动文件

• appname: 包含应用品牌信息，如应用名称。
• docker: 包含 Dockerfile 和其他 Docker 相关配置文件。
• documentation: 存放项目文档的文件夹。
• migrations: 包含数据库迁移的脚本。
• tests: 包含单元测试和功能测试。
• tmp: 存放临时文件的目录。
• .github: GitHub 工作流程和配置文件。
• .vscode: VSCode 项目设置。

2. 项目的启动文件介绍

项目的启动文件是 manage.py，它是 Flask 应用的管理接口。通过此文件可以执行数据库迁移、运行开发服务器、执行测试等操作。以下是一些常用的命令：

./manage.py server          # 启动开发服务器
./manage.py resetdb         # 重置数据库（慎用！）
./manage.py test            # 运行测试用例

3. 项目的配置文件介绍

项目的主要配置文件是 .env.local.sample，它是一个环境变量样本文件，用于设置应用运行时所需的环境变量。在实际部署时，需要将其复制为 .env.local 文件并填入实际的配置信息。

以下是 .env.local.sample 文件中一些重要的环境变量示例：

# Flask 应用配置
FLASK_APP=manage.py
FLASK_ENV=development

# 数据库配置
DATABASE_URL=postgres://user:password@localhost/dbname

# Stripe 配置
STRIPE_SECRET_KEY=your_stripe_secret_key
STRIPE_PUBLISHABLE_KEY=your_stripe_publishable_key

# OAuth 配置
GOOGLE_OAUTH_CLIENT_ID=your_google_client_id
GOOGLE_OAUTH_CLIENT_SECRET=your_google_client_secret

在实际使用时，需要将上述样本值替换为实际的配置值，并确保 .env.local 文件不会被提交到版本控制系统中。

Ignite A comprehensive Flask boilerplate to build SaaS applications that includes Stripe billing, emails, login, and OAuth. 项目地址: https://gitcode.com/gh_mirrors/ignite1/Ignite