gh next

Ein einfacher Klon Github im nächsten.js

Als einfache Alternative Open Source in Github (ironisches Recht?) Zielen ist, mit einigen der Kernmerkmale des Github -funktionierenden Github -Funktionen voll funktionsfähig zu sein.

Weitere Informationen zu den unterstützten Funktionen finden Sie in #84.

Euen Dieses Projekt befindet sich in aktiver Entwicklung Euen

Erwarten Sie, dass Sachen brechen.

Roadmap

Klicken Sie hier, um mehr zu sehen

• Anmeldung/Abmelden
• Homepage (Readme -Inhalt)
• Responsive Layout
• Einstellungsseite für das Umschalten des Themas
• Stargazers Seite
• Siehe Profilinformationen
  • Benutzername aktualisieren
  • Thema ändern
  • Benutzerdetailseite
• Ausgabenliste Seite
  • Such- und Filterprobleme nach Autor, Etikett, Beauftragter, geschlossen/geöffnet, Titel, Erwähnungen usw. (Inspiration: https://github.com/openstatushq/openstatus, https://docs.github.com/en/issues/tracking-your-with- isues/filtering-and-ssearing----Suesuesuesuesuesuesuesuesuesuesuesuesuesuesuesuesuesuesuesuesuesuesuesuesuise
• Neue Ausgabeseite
  • CRUD ausgeben (nur vom Autor)
  • Kommentare crud
  • Erwähnungen
  • Popovers ausgeben (zur Vorschau von Problemen)
  • Verknüpfung zwischen Problemen
  • Probleme zuweisen und selbst zuweisen
• OpenGraph
  • Landung (Inspiration: https://github.com/trpc/trpc/blob/main/www/og-image/pages/api/landing.tsx)
  • Pro Repository
  • Pro Benutzer
  • Per Issue (inspiration: https://opengraph.githubassets.com/101e5bdeef8e959c800fab2aef88eef0b01b15d883e3e17c990bde8dfd67d6b3/trpc/trpc/issues/4306)
• Beschriftungen CRUD (kann nur Beschriftungen hinzufügen oder aktualisieren, kein Löschen)
• Benachrichtigungen Seite
  • Benachrichtigungsabzeichen (Inspiration: https://gist.github.com/fredkiss3/ab918aee3977d681f0508537a4838c0, https://github.com/fredkiss3/bunrest)
  • Benachrichtigungen für Themenabonnements
  • Benachrichtigungen für Erwähnungen
  • Benachrichtigungen für den Problemstatus
  • Filterbenachrichtigungen nach Status, Titel, geschlossen usw.
  • Markieren Sie wie fertig, abmelden
• Dateien Hosting für Repos (mit einem Speicherlimit)
  • Datei -Surfen UI
  • Dateisuche
• Repository -Liste
  • Liste der Repos
  • Suche nach Repos
• Git Web UI
  • Geschichte begehen
  • Zeitreisen
  • Unterstützen Sie git push und git remote -Befehle
• Ausgeben von Kanban Board (wie Github Projects), um ein Problem entweder mit einem Commit oder aus der Benutzeroberfläche zu schließen
• CI/CD
  • Wenn wir CI mit Docker leiten, können wir uns von Gitlab inspirieren lassen

Stapel

• Nächster App -Router
• Nieselregen + lokale Postgres -Datenbank
• Sehen Sie sich den CI/CD -Workflow für die Bereitstellung des CI/CD -Workflows an, die alle bereitgestellt werden
• Rückenwindcss für das Styling

Anforderungen

• Knoten> = v18.x
• pnpm> = v8.x
• Docker für die lokale Entwicklung installiert
• Eine registrierte Github -App zur Authentifizierung von Benutzern

Wie arbeite ich an dem Projekt?

1. Zuerst müssen Sie das Repository klonen

   git clone https://github.com/Fredkiss3/gh-next.git

2. Starten Sie die Docker -Kompose -Instanz, um die DB + Redis -Instanz zu starten:

   docker-compose up -d --remove-orphans

3. Installieren Sie die Abhängigkeiten:

   pnpm install

4. Nennen Sie .env.example in .env.local und ändern Sie die Datei in Ihre Anforderungen.

5. Und starten Sie das Projekt:

   pnpm run dev

   Die App wird unter http: // localhost: 3000 angezeigt.

6. Öffnen Sie den Quellcode und schaukeln! ?

? Projektstruktur

Ein kurzer Blick auf die obersten Dateien und Verzeichnisse, die Sie in diesem Projekt sehen.

  .
  ├── src/
  │    ├── app
  │    ├── actions
  │    ├── components
  │    ├── models
  │    └── lib/
  │         ├── client
  │         ├── server
  │         └── shared
  ├── biome.json
  ├── pnpm-lock.yaml
  └── tsconfig.json

1. src/app/ : Dieser Ordner enthält alle Routen und Seiten unserer App.

2. src/actions : Dieser Ordner enthält die gesamte Logik unserer App.

3. src/components : Dieser Ordner enthält alle Komponenten unserer App.

4. src/models : Dieser Ordner enthält alle DB -Modelle unserer App.

5. src/lib/ : Dieser Ordner enthält Utils & Helpers, die in unserer App verwendet werden:

   1. client : Dieser Ordner enthält alle Dienstprogramme, die nur von Clients sind und normalerweise von Client-Komponenten verwendet werden. Es enthält hauptsächlich Haken

   2. server : Dieser Ordner enthält alle Dienstprogramme, die nur server sind, für die Verwendung in Serverkomponenten und Serveraktionen. Es enthält auch die DB -Schemata im db/schema

   3. shared : Dieser Ordner enthält alle Dienstprogramme, die zwischen Server und Client gemeinsam genutzt werden. Diese können überall in der App verwendet werden.

6. biome.json : Diese Datei enthält die Konfiguration für Biome, um die automatische Formatierung zu ermöglichen.

7. pnpm-lock.yaml : Diese Datei enthält die Abhängigkeiten für das Repo.

8. tsconfig.json : Diese Datei enthält die Konfiguration für Typscript, die von allen zugrunde liegenden Paketen verwendet wird

? Env Variablen verwendet

Nom	Rolle
SESSION_SECRET	Zufällige 32 Zeichen Länge String, die zur Codierung der Sitzungs -ID verwendet wird
REDIS_HTTP_URL	Die URL zur Verbindung zu Redis HTTP für einen Schlüssel-/Wertspeicher
DATABASE_URL	Die URL zur Verbindung zur Postsbank für die Nachstrahlung
REDIS_HTTP_USERNAME	Lokale Dateiserver -URL zum Speichern von Schlüsselwerten
REDIS_HTTP_PASSWORD	Lokale Dateiserver -URL zum Speichern von Schlüsselwerten
GITHUB_CLIENT_ID	GitHub Client -ID, die für unsere App gespeichert ist, verwendet zur Authentifizierung von Benutzern mit GitHub
GITHUB_PERSONAL_ACCESS_TOKEN	GitHub Client -Token, das für unsere App gespeichert ist
GITHUB_REDIRECT_URI	URL zur Umleitung, wenn ein Benutzer authentifiziert wurde
GITHUB_SECRET	Github Secret, das für unsere App gespeichert ist