Wishing Plan

希望计划

希望计划允许用户跟踪储蓄并计算用户愿望的可行性。它也将成为计划与他人进行更大购买的枢纽，创建个人或集体的愿望清单，以期在生日，圣诞节等人等情况下分享。

加入我们的Discord Server，以进行更快的响应，并就希望计划进行更轻松的讨论。

开源

希望计划是一个开源项目。我们欢迎社区的贡献。从编写教程或博客文章，提交错误报告和功能请求或编写代码，可以将可以纳入希望计划本身，从而为项目做出贡献。这是您可以为该项目做出贡献的一些方式的列表：

• 报告错误 - 如果找到错误，请在“问题跟踪器”中报告。
• 建议新功能 - 如果您有新功能的想法，请在“问题跟踪器”中建议。
• 实现新功能 - 如果要实现新功能，请在“问题跟踪器”中创建问题并描述要实现的功能。这将使我们能够讨论该功能并确保与项目符合该功能。
• 提高代码质量 - 我们使用Sonarcloud和代码来衡量项目的代码质量。您可以通过修复错误和漏洞来帮助我们提高代码质量。
• 改进文档 - 如果您在文档中找到任何错误或想改进该错误，请通过拉动请求做出贡献。
• 将来，我们将要实施该应用程序的翻译。如果您有兴趣为我们提供帮助，请通过[email protected]与我们联系。

入门

先决条件

• 安装PNPM全球npm install -g pnpm
• Insdall Docker，例如，用于Linux的Windows或Docker Engine的Docker桌面。有关更多信息，请参见Docker安装。
  • 这是一个本地数据库进行开发。

文员仪表板设置

要使此应用程序工作，您需要将Discord作为OAuth提供商。您可以在店员仪表板中找到User & Authentication / Social Providers的社交选项

如果在添加Discord之外更改此处的任何设置，则需要更新EXPO代码以处理您更改的任何要求。

文员Webhook设置

要处理用户创建和删除，您需要在店员仪表板上设置Webhook。您可以在User & Authentication / Webhooks下找到Webhook设置。您需要添加一个Webhook，其中订阅的事件user.created user.deleted 。为了使职员与本地开发服务器进行通信，您需要使用Ngrok等工具将本地开发服务器公开到Internet。您可以在此处找到NGROK设置说明。

安装和设置

• 克隆存储库
• 创建本地.env cp .env.example .env并填写值
• 店员的设置环境变量
• 安装依赖项pnpm install或仅pnpm i
• 启动数据库pnpm db:dev
• 运行pnpm db:push将数据库模式推到数据库
• 运行开发服务器pnpm dev

有关更多信息 - 博览会设置

代码布局

它使用turborepo并包含：

 .github
  └─ workflows
        └─ CI with pnpm cache setup
.vscode
  └─ Recommended extensions and settings for VSCode users
apps
  ├─ expo
  └─ next.js
      ├─ Next.js 13
      ├─ React 18
      └─ E2E Typesafe API Server & Client
packages
 ├─ api
 |   └─ tRPC v10 router definition
 └─ db
     └─ typesafe db-calls using Prisma

项目委员会

对于开发管理，我们正在使用GitHub项目。在那里，您可以看到我们的积压，这是按优先级和大小排序的问题。我们还在其中创建路线图。

回购健康信息

以下是以下衡量存储库的代码健康的当前概述：

• Sonarcloud：https：//sonarcloud.io/summary/overall?id= andreasgdp_wishing-plan
• 代码：https：//codescene.io/projects/33413/jobs/781250/Results

外部发展链接

• 组件库：https：//chakra-ui.com/docs/components

网络信息

我们将为网页提供的最小宽度是240px。

参考

该堆栈起源于Create-T3-Turbo。