README.de.md

Hacktoberfest Checker (https://hacktoberfest.ninja)

Gehostet auf https://hacktoberfest.ninja, informiert Nutzer darüber, ob ein Projekt am Hackoberfest teilnimmt.

Lokales Setup

Als entkoppelte Webanwendung ist Netlify Dev erforderlich, um die Anwendung und die Netlify-Funktion lokal auszuführen und die sites check-repository Funktion zu nutzen.

Netlify Dev

Installiere Netlify Dev lokal.

# installiere Netlify Dev
$ npm install netlify-cli -g

Erstellen eines persönlichen Zugriffstoken

Du müssen ein GitHub Personal Access Token erstellen, um von deiner lokalen Umgebung aus auf die GitHub API zugreifen zu können.

Hier gehts zur Dokumentation und vergesse nicht, den Token zu kopieren, bevor du die Seite verlässt (oder du musst einen neuen erstellen).

Es wird nur die Option public_repo benötigt. Das Hinzufügen weiterer Optionen könnte ein Sicherheitsrisiko darstellen.

Pakete installieren

Führe einen npm installaus um die erforderlichen Pakete für dieses Projekt zu installieren:

npm install

Konfiguration der Umgebung

Erstelle eine `.env' Datei und füge deinen Zugriffs-Token wie hier gezeigt hinzu.

# .env
GITHUB_ACCESS_TOKEN=your_access_token_123

Starten deine lokale Umgebung

Starte die Anwendung mit der Netlify Dev CLI.

$ netlify dev

Funktioniert es?

Die Seite ist standardmäßig unter localhost:8888 verfügbar.

Beitragen

Beiträge willkommen! Siehe Datei BEITRÄGE.

Lizenz

MIT lizenziert. Siehe Datei LIZENZ.

Mitwirkende ✨

Dank geht an diese wunderbaren Menschen (emoji key):

Luke Oliff 🤔 💻 📖 🎨

Charlie 💻 🐛

Rascal_Two 💻

Jason Chan 💻

Nicholas Carrigan (he/him) 💻 🐛

Greg Holmes 📖

Alhassan 💻

Dieses Projekt folgt den Spezifikation [alle-mitwirkenden] (https://github.com/all-contributors/all-contributors). Beiträge jeder Art sind willkommen!