wagtail torchbox

Torchbox.com auf Wagtail - Ruhestand

Warnung

Diese Version des Tarchbox.com Repo ist jetzt im Ruhestand. Sie möchten wahrscheinlich https://github.com/torchbox/torchbox.com.

Der alte Reaminhalt wird unten als Referenz erhalten.

 *
*
*
*
*
*
*
*
*
*

Historische Dokumentation

Dies ist die Haupt -Torchbox.com -Website. Der Karrierenabschnitt dieser Website finden Sie in Torchbox/Karrieren.

Technische Dokumentation

Dieses Projekt enthält technische Dokumentation, die in Markdown im Ordner /docs geschrieben wurden. Dies deckt unter anderem ab:

• kontinuierliche Integration
• Einsatz
• Git -Verzweigung
• Projektkonventionen

Sie können es mit mkdocs durch Ausführen anzeigen:

mkdocs serve

Die Dokumentation wird unter: http: // localhost: 8001/verfügbar sein

Einrichten eines lokalen Builds

Dieses Repository enthält docker-compose Konfiguration zum Ausführen des Projekts in lokalen Docker-Containern und eine Fabile für die Bereitstellung und Verwaltung.

Es gibt eine Reihe anderer Befehle, die mithilfe des Fabric -Skripts bei der Entwicklung helfen. Um sie alle zu sehen, rennen Sie:

fab -l

Abhängigkeiten

Das Folgende ist erforderlich, um die lokale Umgebung zu betreiben. Es wird bestätigt, dass die angegebenen Mindestversionen funktionieren: Wenn Sie bereits ältere Versionen installiert haben, können sie möglicherweise funktionieren, dies jedoch nicht garantiert.

• Docker, Version 19.0.0 oder Up
  • Docker -Desktop für Mac Installer
  • Docker -Engine für Linux -Installateure
• Docker Compose, Version 1.24.0 oder Up
  • Installieren Sie Anweisungen (Nur Linux: Compose ist bereits für Mac-Benutzer als Teil des Docker-Desktops installiert.)
• Stoff, Version 2.4.0 oder Up
  • Anweisungen installieren
• Python, Version 3.6.9 oder Up

Beachten Sie, dass Sie bei Mac OS möglicherweise eine ältere Version von Fabric installiert haben, die möglicherweise die alte Deinstallation deinstallieren und dann die neue Version mit PIP3 installieren:

pip uninstall fabric
pip3 install fabric

Sie können verschiedene Python-Versionen verwalten, indem Sie pyenv einrichten: https://realpython.com/intro-tro-pyenv/

Für die Interaktion mit Produktions- / Staging -Umgebungen benötigen Sie außerdem:

• Heroku Cli
• AWS CLI

Zum ersten Mal den lokalen Build ausführen

Wenn Sie Docker Desktop verwenden, stellen Sie sicher, dass die Ressourcen: Dateifreigabeinstellungen ermöglichen, dass das geklonte Verzeichnis im Webcontainer montiert wird (vermeiden Sie mounting von OCI -Laufzeitfehlern am Ende des Build -Schritts).

Das Starten eines lokalen Builds kann durch Laufen erfolgen:

git clone [email protected]:torchbox/wagtail-torchbox.git
cd wagtail-torchbox
fab build
fab migrate
fab start

Dies startet die Behälter im Hintergrund, jedoch nicht im Django. Stellen Sie dazu eine Verbindung zum Webcontainer mit fab sh her und führen Sie honcho start aus, um sowohl Django als auch den WebPack Dev Server im Vordergrund zu starten.

Schließen Sie dann erneut den Laufbehälter an ( fab sh ) und:

dj createcachetable
dj createsuperuser

Die Website sollte auf dem Host -Computer unter: http://127.0.0.1:8000/ verfügbar sein

Wenn Sie nur das Frontend- oder Backend -Tooling ausführen möchten, sind die Befehle honcho -Runs in docker/Procfile .

Beim ersten Start des Containers existieren die statischen Dateien möglicherweise nicht oder sind nicht veraltet. Um dies zu beheben, führen Sie einfach npm run build aus.

Frontend -Werkzeug

Hier sind die gemeinsamen Befehle:

 # Install front-end dependencies.
npm install
# Start the Webpack build in watch mode, without live-reload.
npm run start
# Start the Webpack server build on port 3000 only with live-reload.
npm run build
# Do a one-off Webpack production build.
npm run build:prod

Es gibt zwei Möglichkeiten, das Frontend -Tooling auszuführen:

• In Docker. Dies ist der Standard, das tragbarste und sicherste, aber viel langsamer auf macOS.
• Oder führen Sie NPM -Befehle von einem Terminal auf Ihrer lokalen Maschine aus. Erstellen Sie eine .env -Datei im Projektroot (siehe .env.example ) mit FRONTEND=local . fab start startet keinen frontend -Container mehr. Wenn Docker nun fab start ausführt, wird er nicht versuchen, an die für den Frontend Dev Server benötigten Ports zu binden, was bedeutet, dass sie lokal ausgeführt werden können. Alle Werkzeuge bleiben im Container weiterhin verfügbar.

Installieren von Python -Paketen

Python -Pakete können mithilfe von poetry im Webbehälter installiert werden:

 fab sh
poetry add wagtail-guide

Um die installierten Abhängigkeiten zurückzusetzen, sind die Datei der poetry.lock -Datei zurückgeführt:

 fab sh
poetry install --no-root

Bereitstellungen

Zusammenführen Sie Ihre Feature -Filiale mit master oder staging -Filiale zusammen. Sobald die CI -Pipelines vergangen sind, wird sie automatisch auf der jeweiligen Heroku -Website eingesetzt.

Dies geschieht über Heroku Github -Integration.