summit 的安装和配置教程

项目基础介绍

Summit 是一个开源的账单和财务管理应用，适用于自由职业者、小型企业和代理机构。它提供了管理财务所需的基本工具，帮助用户高效地处理财务事务。

主要编程语言

该项目主要使用 TypeScript 进行开发。

关键技术和框架

• 框架: Next.js (App Router)
• 语言: TypeScript
• 样式: Tailwind CSS with shadcn/ui
• 数据库: PostgreSQL
• ORM: Drizzle ORM
• 认证: NextAuth.js
• 邮件: Resend
• 支付: Xendit
• 文件存储: Minio (或任何S3兼容的存储)
• 验证: Zod
• 表单: React Hook Form

准备工作

在开始安装之前，请确保您的系统中已经安装以下依赖：

• Node.js (推荐版本 v18 或更高)
• pnpm (也可以使用 npm 或 yarn)
• PostgreSQL 数据库
• Minio 服务器 (或其他 S3 兼容的存储)

安装步骤

1. 克隆仓库

   使用 Git 命令克隆项目仓库到本地：

   git clone https://github.com/kugie-app/summit.git
   cd summit
   

2. 安装依赖

   在项目目录中，使用 pnpm 安装项目依赖：

   pnpm install
   

3. 配置环境变量

   将 .env.example 文件复制为 .env 文件，并填入所需的环境变量：

   cp .env.example .env
   

   请参考文件中的注释，正确配置数据库连接、Minio 配置、支付服务和其他必要的设置。

4. 启动项目

   在完成所有配置后，运行以下命令启动项目：

   pnpm run dev
   

   如果一切设置正确，项目应该会在开发模式下启动，并通过浏览器访问 http://localhost:3000 来查看。

以上是 summit 应用的基础安装和配置指南。请确保按照上述步骤操作，如果在安装过程中遇到问题，可以查看项目的官方文档或通过 GitHub 提交问题。