gh next

Un simple clone de github dans next.js

Une simple open source alternative GitHub sur GitHub (Ironic ORD?), Il vise à être entièrement fonctionnal avec certaines des caractéristiques principales du travail GitHub.

Voir # 84 pour plus d'informations sur les fonctionnalités prises en charge.

️ Ce projet est en développement actif ️

Attendez-vous à ce que les choses se cassent.

Feuille de route

Cliquez pour en voir plus

• Connexion / déconnexion
• Page d'accueil (contenu ReadMe)
• Disposition réactive
• Page Paramètres pour le thème de basculement
• Page Stargazers
• Voir les informations de profil
  • Mettre à jour le nom d'utilisateur
  • Changer le thème
  • Page de détail de l'utilisateur
• Page de liste des problèmes
  • Rechercher et filtrer les problèmes de l'auteur, de l'étiquette, du cessionnaire, fermé / ouvert, titre, mentions, etc. (inspiration: https://github.com/openstaturse/openstatus, https://docs.github.com/enSues/tracking-your-work-with-issues/filtering-secching-issues et-pull-requests)
• Nouvelle page d'émission
  • Publier crud (par l'auteur uniquement)
  • Commentaires Crud
  • Mentions
  • Publier des popovers (pour les problèmes de prévisualisation)
  • Lier entre les problèmes
  • Attribuer des problèmes d'auto-assignation
• Ouverte
  • Landing (Inspiration: https://github.com/trpc/trpc/blob/main/www/og-image/pages/api/landing.tsx)
  • Par référentiel
  • Par utilisateur
  • Par numéro (Inspiration: https://opengraph.githubassets.com/101e5bdeef8e959c800fab2aef88eef0b01b15d883e3e17c990bde8dfd67d6b3/trpc/trpc/issues/4306)
• Labels crud (ne peut qu'ajouter ou mettre à jour les étiquettes, pas de suppression)
• Page de notifications
  • Badge de notifications (inspiration: https://gist.github.com/fredkiss3/ab918aee3977d681f0508537a44838c0, https://github.com/fredkiss3/bunrest)
  • Notifications pour les problèmes abonnements
  • Notifications pour les mentions
  • Notifications pour les statuts des problèmes
  • Notifications de filtre par statut, titre, fermé, etc.
  • Marquez comme fait, désabonnez-vous
• Hébergement de fichiers pour les repos (avec une limite de stockage)
  • Fichier de navigation UI
  • recherche de fichiers
• Liste de référentiels
  • liste des repos
  • Recherche de repos
• Git web ui
  • commettre une histoire
  • voyage dans le temps
  • Prise en charge des commandes git push et git remote
• publier le conseil d'administration de Kanban (comme Github Projects), pour clore un problème avec un engagement ou de l'interface utilisateur
• CI / CD
  • Running CI avec docker, nous pouvons nous inspirer de GitLab

Empiler

• Prochain routeur d'application
• Base de données Postgres locale +
• Hébergé sur un VPS personnalisé, consultez le flux de travail CI / CD pour savoir comment tout est déployé
• tailwindcss pour le style

Exigences

• Nœud> = v18.x
• pnpm> = v8.x
• Docker installé pour le développement local
• Une application GitHub enregistrée pour authentifier les utilisateurs

Comment travailler sur le projet?

1. Vous devez d'abord cloner le référentiel

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

2. Démarrez l'instance Docker Compose pour démarrer l'instance DB + Redis:

   docker-compose up -d --remove-orphans

3. Installez les dépendances:

   pnpm install

4. Renommer .env.example à .env.local et modifier le fichier en vos besoins,

5. Et lancer le projet:

   pnpm run dev

   L'application s'affiche sur http: // localhost: 3000.

6. Ouvrez le code source et commencez à basculer! ?

? Structure du projet

Un aperçu rapide des fichiers et répertoires de niveau supérieur que vous verrez dans ce projet.

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

1. src/app/ : Ce dossier contient tous les itinéraires et pages de notre application.

2. src/actions : Ce dossier contient toute la logique de notre application.

3. src/components : Ce dossier contient tous les composants de notre application.

4. src/models : Ce dossier contient tous les modèles DB de notre application.

5. src/lib/ : Ce dossier contient des utils et des aides utilisés dans notre application:

   1. client : Ce dossier contient tous les utilitaires uniquement, généralement utilisés par les composants clients. Il contient principalement des crochets

   2. server : Ce dossier contient tous les utilitaires uniquement du serveur, pour une utilisation dans les composants du serveur et les actions du serveur. Il contient également les schémas DB à l'intérieur db/schema

   3. shared : Ce dossier contient tous les utilitaires partagés entre le serveur et le client, ceux-ci peuvent être utilisés n'importe où dans l'application.

6. biome.json : Ce fichier contient la configuration du biome pour activer l'autoformat.

7. pnpm-lock.yaml : Ce fichier contient le verrouillage des dépendances pour le dépôt.

8. tsconfig.json : Ce fichier contient la configuration de TypeScript, qui sont utilisées par tous les packages sous-jacents

? Variables Env utilisées

Nom	rôle
SESSION_SECRET	Chaîne de longueur de caractères aléatoire 32 utilisée pour coder l'ID de session
REDIS_HTTP_URL	L'URL à la connexion à redis http pour un magasin de clé / valeur
DATABASE_URL	L'URL à la connexion à la base de données Postres
REDIS_HTTP_USERNAME	URL du serveur de fichiers local pour stocker les valeurs de clés
REDIS_HTTP_PASSWORD	URL du serveur de fichiers local pour stocker les valeurs de clés
GITHUB_CLIENT_ID	ID client GitHub stocké pour notre application utilisée pour authentifier les utilisateurs avec GitHub
GITHUB_PERSONAL_ACCESS_TOKEN	Le jeton client GitHub stocké pour notre application utilisée pour authentifier les utilisateurs avec GitHub
GITHUB_REDIRECT_URI	URL vers la redirection lorsqu'un utilisateur a été authentifié
GITHUB_SECRET	Github Secret stocké pour notre application