Wishing Plan

Желание плана

План желаний позволяет пользователю отслеживать экономию и рассчитывать выполнимость покупки пожеланий пользователя. Он также станет центром планирования больших покупок с другими, создавая индивидуальные или коллективные списки желаний, которыми можно поделиться в таких случаях, как дни рождения, Рождество и многое другое.

Присоединяйтесь к нашему серверу Discord для более быстрых ответов и более простых дискуссий о плане желания.

Открытый исходный код

План желаний - это проект с открытым исходным кодом. Мы приветствуем вклад сообщества. Существует много способов внести свой вклад в проект, от написания учебных пособий или сообщений в блоге, отправки отчетов об ошибках и запросов функций или написания кода, которые могут быть включены в сам план желания. Вот список некоторых способов внести свой вклад в проект:

• Отчеты об ошибках - если вы найдете ошибку, сообщите о ней в трекере выпуска.
• Предложите новые функции - если у вас есть идея для новой функции, пожалуйста, предложите это в трекере выпуска.
• Реализуйте новые функции - если вы хотите внедрить новую функцию, пожалуйста, создайте проблему в трекере выпуска и опишите функцию, которую вы хотите реализовать. Это позволит нам обсудить эту функцию и убедиться, что она соответствует проекту.
• Повышение качества кода - мы используем SonarCloud и Codescene для измерения качества кода нашего проекта. Вы можете помочь нам улучшить качество кода, исправляя ошибки и уязвимости.
• Улучшение документации - если вы найдете какие -либо ошибки в документации или хотите ее улучшить, пожалуйста, внесите вклад в запрос на привлечение.
• В будущем мы захотим внедрить переводы приложения. Если вы заинтересованы в том, чтобы помочь нам в этом, пожалуйста, свяжитесь с нами по адресу [email protected].

Начиная

Предварительные условия

• Установите PNPM Globally npm install -g pnpm
• INSDALL DOCKER EG, Docker Desktop для Windows или Docker Engine для Linux. Смотрите установку Docker для получения дополнительной информации.
  • Это должно иметь локальную базу данных для разработки.

Установка приборной панели клерка

Для этого приложения вам необходимо включить Discord в качестве поставщика OAuth. Вы можете найти социальные варианты в рамках User & Authentication / Social Providers на приборной панели клерка

Если вы измените какие -либо настройки здесь, кроме добавления Discord, вам необходимо обновить код выставки для выполнения любых требований, которые вы измените.

Установка клерка Webhook

Для обработки создания и удаления пользователей вам необходимо настроить веб -крючок на приборной панели клерка. Вы можете найти настройки Webhook в соответствии с User & Authentication / Webhooks . Вам необходимо добавить веб -крюк с подписанными событиями, которые являются user.deleted и user.created . Для того, чтобы клерк мог общаться с вашим локальным сервером разработки, вам необходимо использовать такой инструмент, как NGROK, чтобы выявить ваш локальный сервер разработки в Интернет. Вы можете найти инструкции по настройке 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_WishingL-Plan
• Codescene: https://codescene.io/projects/33413/jobs/781250/results

Внешние ссылки для разработки

• Библиотека компонентов: https://chakra-ui.com/docs/components

Интернет -информация

Самая маленькая ширина, которую мы будем соответствовать веб -странице, составляет 240px.

Ссылки

Стек происходит из Create-T3-Turbo.