codu
1.0.0
Ein Raum für Codierer
Codú ist die ultimative Community von Webentwicklern, um Ihre Projekte zu lernen, zu teilen und zu unterstützen, entweder große oder kleine Projekte. Es ist der perfekte Ort, um Ihre Fähigkeiten zu schärfen und Ihr Portfolio aufzubauen. In Codú sind wir alle hier, um sich gegenseitig als Webentwickler zu wachsen. Außerdem erleichtert Codú, Mitarbeiter für Ihr nächstes großes Projekt zu finden.
Wir haben eine fantastische Gemeinschaft, die auf Zwietracht wächst. Klicken Sie hier, um mitzumachen!
git clone https://github.com/YOUR_USERNAME/codu.git .cd codu .npm install.nvmrc definierten Knotenversion. Wenn Sie nvm verwenden, können Sie nvm use ausführen, bevor Sie Abhängigkeiten installieren..env -Datei und fügen Sie die folgenden Variablen hinzu. Sie können den Inhalt der sample.env kopieren 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
Eine detailliertere Anleitung zum Einrichten finden Sie in den Abschnitt Umgebungsvariablen.
HINWEIS: Stellen Sie vor dem Fahren sicher, dass Ihre Datenbank ausgeführt wird.
npm run db:migrateDer vollständige Befehl ist in unserer Paket.json -Datei zu sehen.
npm run db:seedDer vollständige Befehl ist in unserer Paket.json -Datei zu sehen.
npm run devNavigieren Sie nach Abschluss der oben genannten Befehle zu http: // localhost: 3000 in Ihrem Browser, um das Ergebnis anzuzeigen.
Sie können Ihre Reise beginnen, indem Sie pages/index.tsx ändern. Mit der auto-update-Funktion aktualisieren die Seiten, während Sie die Datei bearbeiten.
Das Verzeichnis pages/api wird /api/* zugeordnet. Dateien in diesem Verzeichnis werden als API -Routen anstelle von React -Seiten behandelt.
Erfahren Sie hier mehr über API -Routen.
Die DATABASE_URL ist eine Verbindungszeichenfolge zu einer PostgreSQL -Datenbank (Version 15.0).
Standardmäßig verweisen wir auf eine Datenbank, die lokal mit Docker aus unserer Datei docker-compose.yml ausgeführt wird.
Um diese Datei auszuführen, stellen Sie sicher, dass Sie Docker installiert haben und dieser Docker ausgeführt wird.
Führen Sie den Befehl docker compose up .
Wenn Sie nach dem Laufen nach PostgreSQL lokal ausgeführt werden, können Sie Ihre lokale Verbindungszeichenfolge verwenden oder einen aus einem kostenlosen Dienst wie Supabase abrufen.
Derzeit erlauben wir nur eine Authentifizierung über GitHub. Um dies zu aktivieren, müssen Sie einen GITHUB_ID und GITHUB_SECRET -Wert haben.
Richten Sie Ihre Github -ID und Ihr Geheimnis auf GitHub ein:
Stellen Sie zur Entwicklung sicher, dass Sie dies mit einer Homepage -URL von festlegen
http://localhost:3000/
und eine Autorisierungsrückruf -URL von
http://localhost:3000/api/auth
Nachdem Sie auf die Schaltfläche "Anwendung registrieren" klicken, sollten Sie das GITHUB_ID sehen und ein neues Client -Geheimnis generieren können. Stellen Sie nach dem Generieren des Geheimnisses sicher, dass Sie diesen Wert in Ihre .env -Datei kopieren, da dieser Wert nicht erneut angezeigt werden kann, sobald Sie die Seite aktualisieren.
Weitere Informationen zur Genehmigung von OAuth in der GitHub -Dokumentation hier.
Um eine passwortlose Login lokal zu verwenden, müssen Sie einen Wert von ACCESS_KEY und SECRET_KEY haben.
Schauen Sie sich die Beispiele .env -Datei hier an, um zu sehen, wie diese Werte füllen.
HINWEIS: Derzeit ist die AWS-Region des SNS-Dienstes für "EU-West-1" hartcodiert. Es kann erforderlich sein, dies zu ändern, wenn sich Ihr SNS -Service in einer anderen Region befindet.
Sie sollten den Standardwert hier nicht ändern müssen. Dies ist eine Variable, die vom nächsten Auth als Authentifizierungs -URL für Ihre Website verwendet wird.
NEXTAUTH_URL=http://localhost:3000/api/auth
Beispiel .Env -Datei finden Sie hier. Sie können dies in .env umbenennen, um loszulegen.
Um mehr über Next.js zu erfahren, sehen Sie sich die folgenden Ressourcen an:
Um sich über die Redakteurverknüpfungen und Hotkeys zu informieren, können Sie sich dieses Dokument ansehen:
Informationen zu E2E -Tests finden Sie in unserer speziellen Dokumentation hier.
Sie sind herzlich eingeladen, Fragen zu eröffnen, um Ideen zur Verbesserung der Codú zu besprechen. Verbesserungen werden gefördert und geschätzt.
