wagtail torchbox

Torchbox.com sur berceau - retraité

Avertissement

Cette version du repo torchbox.com est maintenant à la retraite. Vous voulez probablement https://github.com/torchbox/torchbox.com.

L'ancien contenu REAME est conservé ci-dessous pour référence.

 *
*
*
*
*
*
*
*
*
*

Documentation historique

Ceci est le site Web principal Torchbox.com. La section des carrières de ce site se trouve dans Torchbox / Carrières.

Documentation technique

Ce projet contient une documentation technique écrite dans Markdown dans le dossier /docs . Cela couvre, entre autres:

• intégration continue
• déploiement
• ramification GIT
• Conventions de projet

Vous pouvez le voir à l'aide de mkdocs en fonctionnant:

mkdocs serve

La documentation sera disponible sur: http: // localhost: 8001 /

Configuration d'une construction locale

Ce référentiel comprend une configuration docker-compose pour l'exécution du projet dans des conteneurs Docker locaux, et un fabfile pour provisionner et gérer cela.

Il existe un certain nombre d'autres commandes pour aider au développement à l'aide du script de tissu. Pour les voir tous, courez:

fab -l

Dépendances

Les éléments suivants sont nécessaires pour gérer l'environnement local. Les versions minimales spécifiées sont confirmées pour fonctionner: si vous avez déjà des versions déjà installées, elles peuvent fonctionner, mais ne sont pas garanties de le faire.

• Docker, version 19.0.0 ou UP
  • Docker Desktop pour l'installateur Mac
  • Moteur Docker pour les installateurs Linux
• Docker Compose, version 1.24.0 ou UP
  • Installer des instructions (Linux-Only: Compose est déjà installé pour les utilisateurs Mac dans le cadre de Docker Desktop.)
• Tissu, version 2.4.0 ou haut
  • Installer des instructions
• Python, version 3.6.9 ou UP

Notez que sur Mac OS, si vous avez une ancienne version de tissu installé, vous devrez peut-être désinstaller l'ancien, puis installer la nouvelle version avec PIP3:

pip uninstall fabric
pip3 install fabric

Vous pouvez gérer différentes versions Python en configurant pyenv : https://realpython.com/intro-to-pyenv/

De plus, pour interagir avec les environnements de production / de mise en scène, vous aurez besoin:

• Heroku CLI
• AWS CLI

Exécuter la construction locale pour la première fois

Si vous utilisez Docker Desktop, assurez-vous que les paramètres de ressources: le partage de fichiers permettent au répertoire cloné d'être monté dans le conteneur Web (éviter mounting de mise en marche OCI à la fin de l'étape de construction).

Le démarrage d'une construction locale peut être effectué en fonctionnant:

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

Cela commencera les conteneurs en arrière-plan, mais pas Django. Pour ce faire, connectez-vous au conteneur Web avec fab sh et exécutez honcho start pour démarrer à la fois Django et le serveur de développement WebPack au premier plan.

Ensuite, connectez à nouveau au conteneur en cours d'exécution ( fab sh ) et:

dj createcachetable
dj createsuperuser

Le site doit être disponible sur la machine hôte à: http://127.0.0.1:8000/

Si vous souhaitez uniquement exécuter l'outillage Frontend ou Backend, les commandes que honcho exécute sont dans docker/Procfile .

Au début du conteneur, les fichiers statiques peuvent ne pas exister ou peuvent être obsolètes. Pour résoudre ce problème, exécutez simplement npm run build .

Outillage frontal

Voici les commandes communes:

 # 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

Il existe deux façons d'exécuter l'outillage Frontend:

• Dans Docker. Il s'agit de la valeur par défaut, la plus portable et la plus sécurisée, mais beaucoup plus lente sur les macOS.
• Ou exécutez les commandes NPM à partir d'un terminal de votre machine locale. Créez un fichier .env dans la racine du projet (voir .env.example ) avec FRONTEND=local . fab start ne démarrera plus un récipient frontend . Maintenant, lors de l'exécution fab start , Docker n'essaiera pas de se lier aux ports nécessaires pour le serveur de développement frontal, ce qui signifie qu'ils peuvent être exécutés localement. Tous les outils restent toujours disponibles dans le conteneur.

Installation des packages Python

Les packages Python peuvent être installés à l'aide de poetry dans le conteneur Web:

 fab sh
poetry add wagtail-guide

Pour réinitialiser les dépendances installées à la façon dont elles sont dans le fichier poetry.lock :

 fab sh
poetry install --no-root

Déploiements

Pour déployer, fusionnez votre branche de fonctionnalité pour master ou staging la branche. Une fois les pipelines CI passés, il sera déployé automatiquement sur le site Heroku respectif.

Cela se fait via l'intégration Heroku Github.