💰生财有迹（Wealth Tracker）是一款专注于个人资产分析的应用程序。其核心功能是：全面记录并展示用户的资产状况，帮助用户轻松了解财务现状；运用 AI 能力，结合每种资产的特性和当前环境，提供适宜的财务建议。
## 项目愿景
在当今多元化的经济环境中，个人资产管理变得日益重要。它往往分散于各类金融账户和服务中，例如银行存款与理财产品、移动支付平台（如微信支付、支付宝）、公积金、医保账户、货币基金（例如余额宝）、债券、各种股票及基金产品、房地产、贵金属、外部借款（尽量不做此配置🤫）以及其他投资等等（对于部分朋友，或许还有贷款、欠款等负债）。这些账户中的数额在不断变动，使得快速准确地了解个人总资产状况成为一项挑战。
本项目旨在提供一个高效、直观的解决方案，以应对个人资产管理中的分散性和复杂性。`生财有迹`专注于账户余额及整体数额，避免深陷于单笔收支的琐碎细节。其目标是通过简化操作流程，帮助用户揭示个人资产的整体变化趋势，并通过友好的用户界面，使用户能够轻松记录和洞悉自己的财务信息。如欲了解更多，可移步至博文：[生财有迹 | 您专属的资产跟踪与分析工具](https://fine.niceshare.site/projects/wealth-tracker/)。
## 核心特性
- **简洁易用的操作界面**：用户可以通过几个简单的步骤快速上手，无需任何复杂的财务知识。
- **丰富的数据可视化**：通过图表和图形，直观展示资产变化，帮助用户轻松掌握财务状况。
- **本地部署的灵活性**：部署在哪里由用户决定，确保数据的私密性、安全性，以及可扩展性。
- **开源的代码架构**：项目的源代码完全开放，欢迎参与贡献，以不断改进和完善工具的功能。
- **多语言支持**：支持简体中文、繁体中文、英文、法文、日文，后续会根据用户反馈添加更多。
- **AI 财务建议**：利用 AI 技术，结合每种资产的特性和当前经济环境，提供适宜的财务建议。
- **记录财富见解**：记录投资理财过程中的重要洞察与经验总结，沉淀智慧财富，指导未来决策。
- **密码保护功能**：支持设置访问密码，确保个人财务数据的隐私安全，防止未授权访问。
- **标签分类及可视化**：通过灵活的标签系统对资产进行分类管理，并配合树状图等可视化图表，直观展示不同标签下的资产分布情况。
通过这些特性，希望建立一个用户友好、透明且可信赖的个人财分析工具，帮助用户更全面地掌握自己的财务状况。
## 在线体验
为了让您更直观地了解 [生财有迹](https://fund.lovejade.cn/) 的功能和特性，已在服务器上使用 `pm2` 部署了一个演示版本。该演示环境填充了模拟数据，方便您全面体验各项功能。无论您是想评估工具的实用性，还是出于好奇想一探究竟，欢迎访问以下链接进行体验：
[https://fund.lovejade.cn/](https://fund.lovejade.cn/)
请注意，这是一个公共演示环境，因此**请勿在其中输入任何真实的个人财务信息**。建议您在体验后，考虑按照本文档的指导，在自己的环境中部署和使用「生财有迹」，以确保您的财务数据的隐私和安全。
如果您在使用过程中遇到任何问题或有反馈意见，欢迎通过 [GitHub Issues](https://github.com/nicejade/wealth-tracker/issues) 与我们联系。您的宝贵意见将帮助我们不断改进这一工具，以更好地满足用户的需求。
## 如何使用？
### 桌面应用（Electron）
若希望**在本地完整使用「生财有迹」**（界面与后端服务一并随应用运行，数据保存在本机），可直接从 [GitHub Releases](https://github.com/nicejade/wealth-tracker/releases) 下载对应平台的安装包，安装后打开应用即可；无需单独部署服务器，适合日常在个人电脑上离线使用。
**MacOS 说明**：当前安装包未做 Apple 公证/签名，首次安装后若系统阻止打开，可在终端执行以下命令移除隔离属性后再启动：
```bash
sudo xattr -cr /Applications/Wealth\ Tracker.app
```
### 使用 [Docker](https://hub.docker.com/r/nicejade/wealth-tracker)
**使用 [docker compose](https://docs.docker.com/compose/)**：
创建一个 `docker-compose.yml` 文件，并在其中定义服务（其中 version: '3' 指定了 Docker Compose 文件的版本；您可以根据实际情况进行调整）：
```yaml
version: '3.8'
services:
wealth-tracker:
image: nicejade/wealth-tracker:latest
container_name: wealth-tracker
ports:
- '8888:8888'
volumes:
- ./data:/app/data
restart: unless-stopped
volumes:
data:
```
在包含 `docker-compose.yml` 文件的目录中，运行以下命令启动服务：
```bash
docker-compose up -d
```
这将在后台启动服务，并且效果与下面的 `docker run` 命令相同。使用 Docker Compose 可以更方便地管理多个容器，并且配置更易读和维护。
**或者 docker run**：
```bash
docker run -d -p 8888:8888 -v "$(pwd)/data:/app/data" nicejade/wealth-tracker:latest
```
如果您在本地部署，只需打开网址——[http://localhost:8888](http://localhost:8888/) 即可访问。如果在服务器运行，可通过 http://[Server-IP]:8888 来访问，您也可以指定其他端口。
您可以通过设置以下环境变量来配置应用的行为，详情参见[如何开启密码保护？](https://fine.niceshare.site/projects/wealth-tracker/#如何开启密码保护)：
- `ALLOW_PASSWORD`: 设置为 `true` 启用密码保护功能;
- `PEPPER_SECRET`: 设置它为用户密码提供更强大的保护；
- `CAN_BE_RESET`: 设置为 `true` 允许重置数据库功能;
- `GOOGLE_ANALYTICS_KEY`: Google Analytics 衡量 ID (如 `G-XXXXX`)，配置后将开启页面访问与关键行为埋点（需在构建客户端时注入，新建 根据 `.env.example` 新建 `.env`，填入 ID）。
```bash
docker run -d -p 8888:8888 \
-e ALLOW_PASSWORD=true \
-e CAN_BE_RESET=true \
-v "$(pwd)/data:/app/data" \
nicejade/wealth-tracker:latest
```
### 采用 [pm2](https://pm2.keymetrics.io/) 部署
PM2 是一个强大的生产环境进程管理器，它不仅支持通过命令行启动应用，还可以使用配置文件（通常名为 `ecosystem.config.js`）来管理复杂的部署场景。为了简化部署流程并确保一致性，本项目已将所有必要的 PM2 配置和启动命令封装到了 `npm` 脚本中：
```bash
# clone project
git clone https://github.com/nicejade/wealth-tracker.git
cd wealth-tracker
# globally install pm2 pnpm & lerna
npm i pm2 pnpm lerna -g
# install dependencies(client & server)
pnpm i
# start your service
npm run build
npm run start
```
项目除了提供 `start` 命令外，还包含其他与 `pm2` 相关的命令：
- `npm run start`: 使用 PM2 启动应用；
- `npm run stop`: 停止 PM2 管理的应用；
- `npm run restart`: 重启应用；
- `npm run logs`: 查看应用日志；
## 如何开发？
说明用户在安装和使用前，需要准备的一些先决条件，譬如：您需要安装或升级 [Node.js](https://nodejs.org/en/)（>= `16.*`），推荐使用 [Pnpm](https://pnpm.io/) 或 [Yarn](https://www.jeffjade.com/2017/12/30/135-npm-vs-yarn-detial-memo/) 作为首选包管理工具。本项目采用 pnpm（利用其 workspace 功能）结合 [Lerna@8.1](https://lerna.js.org/) 来管理项目依赖，以实现更高效的包管理和工作流程。为确保您的开发环境与项目要求一致，建议您全局安装这两个工具：
```bash
# clone project
git clone https://github.com/nicejade/wealth-tracker.git
cd wealth-tracker
# globally install pm2 pnpm & lerna
npm i pm2 pnpm lerna -g
# install dependencies(client & server)
pnpm i
cd client && npm start
cd server && npm start
```
本项目客户端采用 [Svelte](https://site.lovejade.cn/post/62a9c2ad90509e23cea772c0) 框架，基于 [Vite](https://site.lovejade.cn/post/6010e1b10c71de1fb957b64e) 所构建，默认 `5173` 端口，只需打开网址—— [http://localhost:5173](http://localhost:5173) 即可访问。
## 给予支持
[生财有迹](https://github.com/nicejade/wealth-tracker)项目开源且免费，然而设计与编码需耗费时间和精力。如若您对其使用感到满意，请考虑通过以下方式进行小额捐赠：
微信扫码赞助
## 路线图
「生财有迹」项目正处于积极的设计和研发阶段，致力于在功能丰富与易用性之间寻求平衡，以满足用户日益增长的个人财务管理需求。未来开发重点包括增强数据可视化能力、加强数据安全性、以及提升 `AI` 辅助分析功能等。如果您想详细了解正在进行的工作和未来规划，欢迎查阅 [生财有迹路线图](https://fine.niceshare.site/projects/wealth-tracker/#路线图)。非常欢迎社区成员参与讨论，为项目的发展方向提供宝贵建议。
## 特别鸣谢
本项目的开发过程中，依赖并受益于以下优秀的开源技术和工具（未包含全部）。它们不仅提供了强大的功能，还促进了项目的高效开发和稳定运行。
- [Svelte](https://svelte.dev/): 作为一种新兴的前端框架，Svelte 通过其创新的编译时技术，让我们的 Web 应用更加轻量和高效。它减少了我们需要编写的样板代码，同时提高了运行时的性能。
- [TailwindCSS](https://tailwindcss.com/): 通过提供实用主义的 CSS 类，TailwindCSS 极大地简化了样式设计的过程。它使得我们能够快速构建美观且响应式的用户界面，同时保持代码的清晰和维护性。
- [Vite](https://vitejs.dev/): 作为一个现代化的前端构建工具，Vite 通过其快速的冷启动和即时的模块热更新，极大地提高了我们的开发效率。它利用了原生 ES 模块特性，使得项目构建更加高效。
- [Flowbite](https://flowbite.com/): 提供了一系列预构建的组件和模板，Flowbite 极大地加快了我们的开发流程。它帮助我们快速实现了复杂的用户界面元素，同时保持了代码的可定制性和可维护性。
- [Flowbite-Svelte](https://flowbite-svelte.com/): 作为 Flowbite 的 Svelte 版本，Flowbite-Svelte 提供了一系列预构建的组件和模板，极大地加快了我们的开发流程。它帮助我们快速实现了复杂的用户界面元素，同时保持了代码的可定制性和可维护性。
- [Axios](https://axios-http.com/): 作为一个基于 Promise 的 HTTP 客户端，Axios 简化了我们的 Web 应用中与 API 的交互。它的易用性和广泛的功能集使得我们能够轻松处理 HTTP 请求和响应。
- [Day.js](https://day.js.org/): 作为一个轻量级的 JavaScript 日期库，Day.js 提供了直观的 API 来处理日期和时间。它使得我们在应用中处理复杂的日期计算变得简单且可靠。
- [Node.js](https://nodejs.org/): 作为一个高效的 JavaScript 运行环境，Node.js 使得服务器端开发变得前所未有的简单和快速。它的事件驱动和非阻塞 I/O 模型极大地提高了我们的应用性能和响应速度。
- [Fastify](https://www.fastify.io/): 这个高性能的 Node.js Web 框架为我们提供了一个简单且强大的接口来构建 RESTful API。它的低开销和高度可扩展性使得我们的后端服务既快速又稳定。
- [SQLite3](https://www.sqlite.org/index.html): 作为一个轻量级的数据库引擎，SQLite3 为我们提供了一个无需配置的本地存储解决方案。它的简单性和高效性使得开发者在本地部署应用时能够轻松管理数据。
- [Sequelize](https://sequelize.org/): 作为一个强大的 ORM 框架，Sequelize 为我们提供了一种简单且直观的方式来管理数据库关系。它的灵活性和功能丰富性使得我们能够轻松实现复杂的数据操作和查询。
- [OpenAI](https://github.com/openai/openai-node): OpenAI 提供的 Node.js SDK 使得我们能够轻松地与人工智能服务（如 ChatGPT、xAI、月之暗面） API 进行集成，从而实现了人工智能相关的功能。
- [pm2](https://pm2.keymetrics.io/): 作为生产环境的进程管理器，pm2 使得我们能够轻松地管理应用的生命周期，包括启动、停止和重启等操作。它的监控和日志功能也使得我们能够更好地了解应用的运行状态。
- [tiptap](https://tiptap.dev/): 作为富文本编辑器，tiptap 提供了简单且可定制的 API 来构建富文本编辑器。它的灵活性和功能丰富性使得我们能够轻松实现复杂的内容编辑功能。
在此，对上述技术和工具的开发者和社区，致以崇高的敬意和衷心的感谢❤️。正是得益于他们的卓越贡献，`生财有迹`才能得以成功构建并持续优化。同时，也要感谢如 [Augment Code](https://www.augmentcode.com/)、[Cursor](https://www.cursor.com/)、[Codeium Windsurf](https://codeium.com/windsurf)、[Trae](https://www.trae.ai/)、 [ChatGPT](https://chatgpt.com/)、[Kimi](https://kimi.moonshot.cn/) 等 AI 工具在开发过程中提供的宝贵支持，它们显著提高了工作效率和体验。
## 相关链接
- [逍遥自在轩](https://www.niceshare.site/)
- [清风明月轩](https://www.lovejade.cn/)
- [晚晴幽草轩](https://www.jeffjade.com/)
- [缘知随心庭](https://fine.niceshare.site/)
- [玉桃文飨轩](https://share.lovejade.cn/)
- [倾城之链](https://site.lovejade.cn/)
- [曼妙句子](https://read.lovejade.cn/)
- [SegmentFault](https://segmentfault.com/u/jeffjade)
- [X | MarshalXuan](https://x.com/MarshalXuan)
- [@MarshalXuan](https://www.youtube.com/@MarshalXuan)
## Star 历史
[](https://www.star-history.com/#nicejade/wealth-tracker&Date)
## 执照
[MIT](http://opensource.org/licenses/MIT)
版权所有 (c) 2024-至今，[逍遥自在轩](https://www.niceshare.site/)。
