10kbclub

10 KB Club

Hinweis: Dieses Projekt ist nicht mehr aufrechterhalten.

Dies ist der Quellcode von 10KBClub.com.

Inhalt

• Eine neue Website vorschlagen
• Entwicklungsaufbau
• Richtlinien begehen
• Zusätzliche Details
• Lizenz
• Unterstützung

Eine neue Website vorschlagen

Lesen Sie zuerst die Clubregeln. Wenn die neue Website die Clubregeln erfüllt, erstellen Sie ein neues Problem und stellen Sie die URL der Website an.

Entwicklungsaufbau

Führen Sie die folgenden Schritte aus, um dieses Projekt lokal zu erstellen und vor Ort zu entwickeln:

1. Klonen Sie dieses Repository:

   git clone https://github.com/susam/10kbclub.git

2. Knoten installieren.

   Geben Sie auf macOS den folgenden Befehl ein, wenn Sie ein Homebrew haben:

   make mac-setup

   Geben Sie auf Debian, Ubuntu oder einem anderen Debian-basierten Linux-System den folgenden Befehl ein:

    make deb-setup
   

3. Geben Sie den folgenden Befehl ein, um eine lokale Kopie der Website zu erstellen:

   make render

4. Öffnen Sie nun index.html mit einem Webbrowser, um die Ausgabe anzuzeigen.

Entwicklungsaktivitäten

1. Geben Sie in einem Linux -System den folgenden Befehl ein, um sicherzustellen, dass das Verzeichnis für Knotenbinärdateien zur PATH hinzugefügt wird:

    . ./env

2. Geben Sie den folgenden Befehl ein, um eine Datei mit dem Namen metrics.yaml zu generieren, die für jede URL in der Datei src/urls.yaml Metrikendaten enthalten:

   node src/refresh.js

3. Geben Sie den folgenden Befehl ein, um die Startseite mit den Daten in metrics.yaml zu rendern.

   node src/render.js

4. Geben Sie den folgenden Befehl ein, um eine einzelne URL zu holen und ihre Metriken auszudrucken:

   node src/metrics.js https://www.example.com/

   Dieses Skript akzeptiert auch mehrere URL -Argumente wie folgt:

   node src/metrics.js https://www.example.com/ https://www.example.org/

Richtlinien begehen

Die folgenden Richtlinien werden in den von manuell gemachten Commits befolgt:

1. Die folgenden Befehle sollten ohne Fehler erfolgreich sein:

   make checks
   make render

2. Commit -Nachrichten werden gemäß den Richtlinien in diesem Dokument geschrieben: Schreiben guter Feststellnachrichten.

Zusätzliche Details

Dieser Abschnitt enthält einige zusätzliche Details, die für das Verständnis dieses Projekts nützlich sein könnten.

1. Das Projektrepository unter https://github.com/susam/10kbclub wird automatisch als https://10kbclub.com/ mit GitHub -Seiten veröffentlicht.

2. Der Build -Job, um die Website zu veröffentlichen, wird jeden Samstag automatisch sowie bei jedem Push über Github -Aktionen automatisch ausgeführt. Siehe live.yml für den Workflow von Github Action. Siehe https://github.com/susam/10kbclub/actions für die vorherigen Ausführungen des Workflows.

3. Die Links zu Diskussionsthemen in js/urls.yaml sind nicht erschöpfend. Nur die 5 frühesten Diskussionsfäden, die 100 Punkte oder mehr haben, wurden aus jedem Forum ausgewählt.

Lizenz

Dies ist kostenlose und Open -Source -Software. Sie können nach den Bedingungen der MIT -Lizenz kopieren, kopieren, ändern, verschmelzen, veröffentlichen, verteilen, unterlizenzieren und/oder verkaufen. Weitere Informationen finden Sie unter Lizenz.MD.

Diese Software wird "wie es ist" ohne Garantie jeglicher Art bereitgestellt, ausdrücklich oder impliziert. Weitere Informationen finden Sie unter Lizenz.MD.

Unterstützung

Um Fehler zu melden, Verbesserungen vorzuschlagen oder Fragen zu stellen, Probleme zu erstellen.