Wishing Plan

Wunschplan

Durch den Wunschplan kann der Benutzer Einsparungen verfolgt und den Kauf von Machbarkeit der Wünsche des Benutzers berechnet. Es wird auch zu einem Hub für die Planung größerer Einkäufe mit anderen und erstellt individuelle oder kollektive Wunschlisten, die Anlässe wie Geburtstage, Weihnachten und mehr teilen können.

Schließen Sie sich unserem Discord -Server für schnellere Antworten und einfachere Diskussionen über den Wunschplan an.

Open Source

Wunschplan ist ein Open -Source -Projekt. Wir begrüßen Beiträge der Community. Es gibt viele Möglichkeiten, um zum Projekt beizutragen, Tutorials oder Blog -Beiträge zu schreiben, Fehlerberichte und Feature -Anfragen oder Schreibcode zu senden, die in den Wunschplan selbst aufgenommen werden können. Hier finden Sie eine Liste der Möglichkeiten, wie Sie zum Projekt beitragen können:

• Melden Sie Fehler an - Wenn Sie einen Fehler finden, melden Sie ihn bitte im Ausgabe -Tracker.
• Schlagen Sie neue Funktionen vor - Wenn Sie eine Idee für eine neue Funktion haben, schlagen Sie diese bitte im Problem Tracker vor.
• Neue Funktionen implementieren - Wenn Sie eine neue Funktion implementieren möchten, erstellen Sie bitte ein Problem im Problem Tracker und beschreiben Sie die Funktion, die Sie implementieren möchten. Auf diese Weise können wir die Funktion besprechen und sicherstellen, dass sie zum Projekt passt.
• Verbesserung der Codequalität - Wir verwenden Sonarcloud und Codescen, um die Codequalität unseres Projekts zu messen. Sie können uns helfen, die Codequalität zu verbessern, indem Sie Fehler und Schwachstellen beheben.
• Verbesserung der Dokumentation - Wenn Sie Fehler in der Dokumentation finden oder sie verbessern möchten, tragen Sie bitte eine Pull -Anfrage bei.
• In Zukunft möchten wir Übersetzungen der App implementieren. Wenn Sie uns dabei helfen möchten, kontaktieren Sie uns bitte unter [email protected].

Erste Schritte

Voraussetzungen

• Installieren Sie PNPM global npm install -g pnpm
• INSDALL DOCKER EG, Docker Desktop für Windows oder Docker Engine für Linux. Weitere Informationen finden Sie unter Docker -Installation.
  • Dies soll eine lokale Datenbank für die Entwicklung haben.

Angestellter Dashboard -Setup

Damit diese App funktioniert, müssen Sie Discord als OAuth -Anbieter ermöglichen. Sie finden die sozialen Optionen unter User & Authentication / Social Providers im Clerk Dashboard

Wenn Sie hier außerhalb des Hinzufügens von Discord eine Einstellung ändern, müssen Sie den Expo -Code aktualisieren, um alle von Ihnen geänderten Anforderungen zu erfüllen.

Clerk Webhook Setup

Um die Erstellung und Löschung der Benutzer zu bearbeiten, müssen Sie einen Webhook im Clerk Dashboard einrichten. Die Webhook -Einstellungen finden Sie unter User & Authentication / Webhooks . Sie müssen einen Webhook mit den user.deleted Ereignissen hinzufügen user.created Damit der Angestellte mit Ihrem lokalen Entwicklungsserver kommuniziert, müssen Sie ein Tool wie NGROK verwenden, um Ihren lokalen Entwicklungsserver dem Internet auszusetzen. Hier finden Sie die NGROK -Setup -Anweisungen.

Installation und Setup

• Klonen Sie das Repository
• Erstellen Sie lokal .Env cp .env.example .env und füllen Sie die Werte aus
• Setup -Umgebungsvariablen für den Angestellten
• Installieren Sie Abhängigkeiten pnpm install oder nur pnpm i
• Starten Sie die Datenbank pnpm db:dev
• Führen Sie pnpm db:push , um das Datenbankschema in die Datenbank zu drücken
• Führen Sie den Entwicklungsserver pnpm dev aus

Weitere Informationen - Expo -Setup

Code -Layout

Es verwendet Turborepo und enthält:

 .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

Projektboard

Für das Entwicklungsmanagement verwenden wir Github -Projekte. Dort können Sie unseren Rückstand sehen, Probleme, die nach Priorität und Größe sortiert sind. Wir arbeiten auch daran, dort eine Roadmap zu erstellen.

Repo -Gesundheitsinformationen

Hier ist der aktuelle Überblick über die Codegesundheit des Repositorys, das gemessen wird:

• Sonarcloud: https://sonarcloud.io/summary/overall?id=andreasgdp_wishing-plan
• Codescen: https://codescene.io/projects/33413/jobs/781250/results

Externe Links für die Entwicklung

• Komponentenbibliothek: https://chakra-ui.com/docs/components

Webinformationen

Die kleinste Breite, die wir für die Webseite erhalten, beträgt 240px.

Referenzen

Der Stapel stammt von Create-T3-Turbo.