Ghostfolio项目开发环境搭建与使用指南

Ghostfolio项目开发环境搭建与使用指南

ghostfolio Open Source Wealth Management Software. Angular + NestJS + Prisma + Nx + TypeScript 🤍 项目地址: https://gitcode.com/gh_mirrors/gh/ghostfolio

前言

Ghostfolio是一款开源的财富管理工具，本文将详细介绍如何搭建Ghostfolio的开发环境，包括环境准备、项目配置、开发流程以及相关工具的使用方法。无论你是前端开发者还是后端工程师，都能通过本指南快速上手Ghostfolio项目的开发工作。

开发环境准备

系统要求

在开始之前，请确保你的开发机器满足以下基本要求：

1. Docker环境：用于运行PostgreSQL数据库和Redis服务
2. Node.js 22+：作为项目的主要运行环境
3. 代码编辑器：推荐使用Visual Studio Code，但其他编辑器也可

环境配置步骤

1. 安装依赖：执行npm install安装所有项目依赖
2. 启动数据库服务：使用Docker启动PostgreSQL和Redis

   docker compose -f docker/docker-compose.dev.yml up -d
   

3. 初始化数据库：运行npm run database:setup创建数据库表结构
4. 环境变量配置：复制.env.dev文件为.env并根据实际情况修改配置

项目启动与运行

后端服务启动

Ghostfolio采用前后端分离架构，后端服务可以通过以下两种方式启动：

1. 调试模式：

   npm run watch:server
   

   在VS Code中使用"Debug API"功能进行调试

2. 普通运行模式：

   npm run start:server
   

前端开发服务器

启动前端开发服务器：

npm run start:client

启动后，在浏览器中访问https://localhost:4200/en即可看到应用界面。

首次使用时，通过"Get Started"创建的第一个用户将自动获得ADMIN角色权限。

数据库管理

数据库迁移

Ghostfolio使用Prisma作为ORM工具，数据库迁移是开发过程中的常见操作：

1. 快速同步数据库结构（适用于开发环境）：

   npm run database:push
   

2. 创建正式迁移文件：

   npm run prisma migrate dev --name your_migration_name
   

3. 数据库可视化工具：

   npm run database:gui
   

   这将启动Prisma Studio，提供直观的数据库管理界面。

组件开发与测试

Storybook组件库

Ghostfolio使用Storybook作为组件开发环境：

npm run start:storybook

Storybook提供了独立的组件开发环境，方便开发者单独测试和展示UI组件。

测试执行

运行项目测试套件：

npm test

高级开发技巧

实验性功能开发

Ghostfolio支持通过功能开关控制新功能的展示：

1. 后端实现：在UserService中使用without()方法移除权限检查
2. 前端实现：在模板中使用条件判断

   @if (user?.settings?.isExperimentalFeatures) {
     <!-- 实验性功能代码 -->
   }
   

依赖管理

1. Angular版本升级：

   npx npm-check-updates --upgrade --target "minor" --filter "/@angular.*/"
   

2. Nx工作区升级：

   npx nx migrate latest
   npm install
   npx nx migrate --run-migrations
   

安全配置

开发证书配置

为本地开发环境配置安全连接：

openssl req -x509 -newkey rsa:2048 -nodes -keyout apps/client/localhost.pem -out apps/client/localhost.cert -days 365 -subj "/C=CH/ST=State/L=City/O=Organization/OU=Unit/CN=localhost"

版本控制建议

推荐使用rebase方式保持提交历史的整洁：

git rebase -i --autosquash main

结语

通过本文的指导，你应该已经能够顺利搭建Ghostfolio的开发环境并开始进行功能开发。Ghostfolio项目采用了现代化的技术栈和开发流程，包括Nx工作区、Prisma ORM、Angular框架等，为开发者提供了良好的开发体验。在实际开发过程中，建议充分利用Storybook进行组件开发，使用Prisma Studio管理数据库，这些工具将大大提高你的开发效率。

ghostfolio Open Source Wealth Management Software. Angular + NestJS + Prisma + Nx + TypeScript 🤍 项目地址: https://gitcode.com/gh_mirrors/gh/ghostfolio