Budget Zen Web App 安装与配置指南

Budget Zen Web App 安装与配置指南

budgetzen-web Simple, Encrypted Budgets & Expenses. Take back control of your budgets and expenses in a simple way, achieve piece of mind, and maintain control of your data. This is the PWA/Web app for Budget Zen (frontend and backend / serverful). 项目地址: https://gitcode.com/gh_mirrors/bu/budgetzen-web

1. 项目基础介绍

Budget Zen 是一个简单、安全的预算和支出追踪应用，支持端到端加密。它是一个渐进式Web应用（PWA），可以在任何设备上通过网页使用。该项目是基于 TypeScript 和 JavaScript 开发的，旨在提供无需额外依赖、打包工具或构建器的简洁体验。

2. 项目使用的关键技术和框架

• Deno: 一个简单、现代且安全的JavaScript运行时环境，用于执行后端服务。
• TypeScript: JavaScript的一个超集，添加了静态类型选项，用于提高代码的可靠性和维护性。
• Web Crypto Standards: 用于在客户端进行安全的加密处理。
• docker compose: 用于容器化应用，简化部署过程。
• Caddy: 一个支持HTTP/2的Web服务器，可以用来为Deno应用提供HTTPS支持。
• PostgreSQL: 数据库系统，用于存储应用数据。

3. 安装和配置准备工作

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

• Docker
• Docker Compose
• PostgreSQL（可选，用于本地开发）
• Caddy（可选，用于本地HTTPS支持）

安装步骤

1. 克隆项目到本地：

   git clone https://github.com/BrunoBernardino/budgetzen-web.git
   cd budgetzen-web
   

2. 复制.env.sample文件为.env，并编辑.env文件以设置您的环境变量。例如，数据库URL、邮件服务和订阅服务配置（如果不需要可以跳过相关配置）。

   cp .env.sample .env
   

3. 使用Docker Compose启动应用：

   docker compose up -d
   

   这将启动Deno应用和PostgreSQL数据库容器。

4. 初始化数据库：

   docker compose run --rm website bash -c "cd /app && make migrate-db"
   

   这将运行数据库迁移脚本来设置数据库模式。

5. 如果您希望本地运行HTTPS，可以启动Caddy：

   sudo caddy run
   

   Caddy会配置好HTTPS并代理到Deno应用。

6. 运行应用：

   应用现在应该可以通过https://localhost访问。如果是在开发环境中，可以使用以下命令启动Deno应用：

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

请确保按照上述步骤操作，如果遇到问题，请检查.env文件中的配置是否正确，并确保所有依赖都已正确安装。在开发过程中，您可能需要运行数据库迁移或格式化代码，可以使用以下命令：

• 运行数据库迁移：

  make migrate-db
  

• 格式化代码：

  make format
  

• 运行测试：

  make test
  

以上就是Budget Zen Web App的基本安装和配置指南。按照这些步骤，即使是编程小白也可以顺利搭建和运行该项目。

budgetzen-web Simple, Encrypted Budgets & Expenses. Take back control of your budgets and expenses in a simple way, achieve piece of mind, and maintain control of your data. This is the PWA/Web app for Budget Zen (frontend and backend / serverful). 项目地址: https://gitcode.com/gh_mirrors/bu/budgetzen-web