codu
1.0.0
Un espace pour les codeurs
Codú est la communauté ultime de développeurs Web pour apprendre, partager et obtenir le soutien de vos projets, grands ou petits. C'est l'endroit idéal pour affiner vos compétences et développer votre portefeuille. À Codú, nous sommes tous ici pour nous aider à grandir en tant que développeurs Web. De plus, Codú facilite la recherche de collaborateurs pour votre prochain grand projet.
Nous avons une communauté fantastique qui grandit sur Discord. Cliquez ici pour rejoindre!
git clone https://github.com/YOUR_USERNAME/codu.git .cd codu du répertoire du projet.npm install.nvmrc . Si vous utilisez nvm , vous pouvez exécuter nvm use avant d'installer des dépendances..env et ajoutez les variables suivantes. Vous pouvez copier le contenu de sample.env avec cat sample.env > .env . # This default value is if you run our local docker-compose.yml file to create the database.
DATABASE_URL=postgresql://postgres:[email protected]:5432/postgres
# Setup your GitHub ID & Secret on GitHub: https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps
# For development, make sure you set up this with a Homepage URL of http://localhost:3000/ and an Authorization callback URL of http://localhost:3000/api/auth
GITHUB_ID=YOUR_GITHUB_APP_ID
GITHUB_SECRET=YOUR_GITHUB_APP_SECRET
NEXTAUTH_URL=http://localhost:3000/api/auth
Pour un guide plus détaillé pour les configurer, allez dans la section Variables Environment.
Remarque: Avant de continuer, assurez-vous que votre base de données est en cours d'exécution.
npm run db:migrateLa commande complète peut être vue dans notre fichier package.json.
npm run db:seedLa commande complète peut être vue dans notre fichier package.json.
npm run devUne fois les commandes ci-dessus, accédez à http: // localhost: 3000 dans votre navigateur pour voir le résultat.
Vous pouvez commencer votre voyage en modifiant pages/index.tsx . Avec la fonction de mise à jour automatique, les pages mettent à jour lorsque vous modifiez le fichier.
Le répertoire pages/api est mappé à /api/* . Les fichiers de ce répertoire sont traités comme des routes API au lieu de réagir des pages.
En savoir plus sur les routes API ici.
La DATABASE_URL est une chaîne de connexion à une base de données PostgreSQL (version 15.0).
Par défaut, nous indiquons une base de données exécutée localement avec Docker à partir de notre fichier docker-compose.yml .
Pour exécuter ce fichier, assurez-vous que Docker est installé et que Docker s'exécute.
Exécutez la commande docker compose up .
Alternativement, si vous avez des fonctions de postgresql localement, vous pouvez utiliser votre chaîne de connexion locale ou en saisir un à partir d'un service gratuit comme Supabase.
Actuellement, nous n'autorisons l'authentification que via GitHub. Pour activer cela, vous devez avoir une valeur GITHUB_ID et GITHUB_SECRET .
Configurez votre ID GitHub et secret sur GitHub:
Pour le développement, assurez-vous de configurer cela avec une URL de page d'accueil de
http://localhost:3000/
et une URL de rappel d'autorisation de
http://localhost:3000/api/auth
Après avoir cliqué sur le bouton "Enregistrer l'application", vous devriez voir le GITHUB_ID et pouvoir générer un nouveau secret client. Après avoir généré le secret, assurez-vous de copier cette valeur sur votre fichier .env car cette valeur ne peut pas être revu une fois que vous avez actualisé la page.
Plus d'informations sur l'autorisation d'Oauth dans la documentation GitHub ici.
Afin d'utiliser la connexion sans mot de passe localement, vous devez avoir une valeur ACCESS_KEY et SECRET_KEY .
Consultez le fichier .env Exemple ici pour voir comment remplir ces valeurs.
Remarque: Actuellement, la région AWS du service SNS est codée en dur à "UE-West-1"; Il peut être nécessaire de changer cela si votre service SNS se trouve dans une région différente.
Vous ne devriez pas avoir besoin de modifier la valeur par défaut ici. Il s'agit d'une variable utilisée par Next Auth comme URL d'authentification sur votre site.
NEXTAUTH_URL=http://localhost:3000/api/auth
Exemple .env Le fichier peut être trouvé ici. Vous pouvez renommer cela à .env pour commencer.
Pour en savoir plus sur Next.js, jetez un œil aux ressources suivantes:
Pour en savoir plus sur les raccourcis en éditeur et les raccourcis clavier, vous pouvez consulter ce document:
Pour plus d'informations sur les tests E2E, veuillez consulter notre documentation dédiée ici.
Vous êtes les bienvenus pour ouvrir des questions pour discuter des idées sur l'amélioration de Codú. Les améliorations sont encouragées et appréciées.
