Prisma-Kysely 开源项目教程
1. 项目的目录结构及介绍
prisma-kysely/
├── src/
│ ├── config/
│ ├── migrations/
│ ├── models/
│ ├── seeders/
│ ├── utils/
│ ├── index.ts
├── prisma/
│ ├── schema.prisma
├── .env
├── .gitignore
├── package.json
├── tsconfig.json
src/
: 包含项目的主要源代码。config/
: 存放配置文件。migrations/
: 存放数据库迁移文件。models/
: 存放数据模型定义。seeders/
: 存放数据种子文件。utils/
: 存放工具函数。index.ts
: 项目的入口文件。
prisma/
: 包含 Prisma 的配置文件。schema.prisma
: Prisma 的数据库模式定义文件。
.env
: 环境变量配置文件。.gitignore
: Git 忽略文件配置。package.json
: 项目的依赖管理文件。tsconfig.json
: TypeScript 配置文件。
2. 项目的启动文件介绍
项目的启动文件是 src/index.ts
。这个文件负责初始化项目并启动应用。以下是 index.ts
的基本结构:
import { createKysely } from '@prisma/kysely';
import { config } from './config';
async function main() {
const db = createKysely(config.database);
// 初始化数据库连接并启动应用
await db.$connect();
// 启动应用逻辑
console.log('Application started');
}
main().catch(err => {
console.error('Failed to start application', err);
process.exit(1);
});
3. 项目的配置文件介绍
项目的配置文件主要有两个:.env
和 src/config/index.ts
。
.env
.env
文件用于存储环境变量,例如数据库连接字符串:
DATABASE_URL="postgresql://user:password@localhost:5432/mydatabase"
src/config/index.ts
src/config/index.ts
文件用于读取和解析 .env
文件中的配置,并提供给应用使用:
import dotenv from 'dotenv';
dotenv.config();
export const config = {
database: {
url: process.env.DATABASE_URL || 'postgresql://user:password@localhost:5432/mydatabase',
},
};
这个配置文件通过 dotenv
库读取 .env
文件中的环境变量,并将其导出供其他模块使用。