Hasura Backend Plus 项目使用教程

Hasura Backend Plus 项目使用教程

hasura-backend-plus 🔑Auth and 📦Storage for Hasura. The quickest way to get Auth and Storage working for your next app based on Hasura. 项目地址: https://gitcode.com/gh_mirrors/ha/hasura-backend-plus

1. 项目的目录结构及介绍

Hasura Backend Plus 的目录结构如下所示：

hasura-backend-plus/
├── .github/             # GitHub 工作流和模板
├── .vscode/             # Visual Studio Code 配置
├── docker/              # Docker 配置文件
├── docs/                # 文档源文件
├── migrations/          # 数据库迁移脚本
├── src/                 # 源代码目录
│   ├── config/          # 配置文件
│   ├── controllers/     # 控制器
│   ├── middlewares/     # 中间件
│   ├── models/          # 数据模型
│   ├── routes/          # 路由
│   ├── services/        # 服务
│   ├── utils/           # 工具函数
│   └── app.ts           # 应用启动文件
├── test-mocks/          # 测试模拟数据
├── .dockerignore        # Docker 忽略文件
├── .editorconfig         # 编辑器配置
├── .eslintignore        # ESLint 忽略文件
├── .eslintrc.js         # ESLint 配置文件
├── .gitignore           # Git 忽略文件
├── .prettierrc.js       # Prettier 配置文件
├── CONTRIBUTING.md      # 贡献指南
├── LICENSE              # 开源协议
├── README.md            # 项目说明文件
├── jest.config.js       # Jest 配置文件
├── package.json         # 项目依赖和脚本
├── prod-paths.js        # 生产环境路径配置
├── tsconfig.json        # TypeScript 配置文件
└── yarn.lock            # 依赖锁定文件

主要目录说明：

• src: 包含所有的源代码，包括配置、控制器、中间件、模型、路由、服务等。
• docker: 包含Docker配置文件，用于容器化应用。
• migrations: 包含数据库迁移脚本，用于更新数据库结构。
• test-mocks: 包含测试时使用的模拟数据。

2. 项目的启动文件介绍

项目的启动文件为 src/app.ts。该文件负责初始化和启动整个应用。以下是启动文件的简要介绍：

// 导入必要的模块和配置
import { createApp } from './app';

// 创建并启动应用
const app = createApp();
app.listen(app.get('port'), () => {
  console.log(`Server is running on port ${app.get('port')}`);
});

createApp 函数负责设置应用的中件间、路由等，并返回一个Express应用实例。

3. 项目的配置文件介绍

项目的配置文件位于 src/config 目录下。以下是一些主要的配置文件及其作用：

• config.ts: 包含应用的基本配置，如端口、数据库连接信息等。
• email.ts: 配置邮件发送相关的设置，如SMTP服务器信息。
• oauth.ts: 配置OAuth认证相关的设置，包括第三方OAuth提供商的密钥和秘密。

配置文件通常使用环境变量来管理不同的环境（开发、测试、生产）下的配置。例如：

// config.ts 示例
import { config } from 'dotenv';
config();

const PORT = process.env.PORT || 3000;
const DATABASE_URL = process.env.DATABASE_URL;

export default {
  port: PORT,
  databaseUrl: DATABASE_URL,
};

通过以上介绍，您应该对Hasura Backend Plus的目录结构、启动文件和配置文件有了基本的了解。您可以参照官方文档进一步深入学习和使用这个项目。

hasura-backend-plus 🔑Auth and 📦Storage for Hasura. The quickest way to get Auth and Storage working for your next app based on Hasura. 项目地址: https://gitcode.com/gh_mirrors/ha/hasura-backend-plus