wagtail torchbox

Torcbox.com en Wagtail - Retirado

Advertencia

Esta versión del repositorio de torcbox.com ahora está retirado. Probablemente desee https://github.com/torchbox/torchbox.com.

El contenido de Reame antiguo se conserva a continuación para referencia.

 *
*
*
*
*
*
*
*
*
*

Documentación histórica

Este es el sitio web principal de Torchbox.com. La sección de carreras de este sitio se puede encontrar en Torchbox/carreras.

Documentación técnica

Este proyecto contiene documentación técnica escrita en Markdown en la carpeta /docs . Esto cubre, entre otros:

• integración continua
• despliegue
• ramificación de git
• Convenciones de proyectos

Puede verlo usando mkdocs ejecutando:

mkdocs serve

La documentación estará disponible en: http: // localhost: 8001/

Configuración de una construcción local

Este repositorio incluye la configuración docker-compose para ejecutar el proyecto en contenedores de Docker locales, y un FabFile para aprovisionar y administrarlo.

Hay una serie de otros comandos para ayudar con el desarrollo utilizando el script de tela. Para verlos a todos, corre:

fab -l

Dependencias

Se requieren lo siguiente para ejecutar el entorno local. Se confirma que las versiones mínimas especificadas están funcionando: si tiene versiones anteriores ya instaladas, pueden funcionar, pero no se garantiza que lo haga.

• Docker, versión 19.0.0 o arriba
  • Docker Desktop para instalador de Mac
  • Motor Docker para instaladores de Linux
• Docker Compose, versión 1.24.0 o arriba
  • Instrucciones de instalación (solo Linux: Compose ya está instalado para los usuarios de Mac como parte del Docker Desktop).
• Tela, versión 2.4.0 o arriba
  • Instalar instrucciones
• Python, versión 3.6.9 o arriba

Tenga en cuenta que en Mac OS, si tiene una versión anterior de Fabric instalada, es posible que necesite desinstalar el anterior y luego instalar la nueva versión con PIP3:

pip uninstall fabric
pip3 install fabric

Puede administrar diferentes versiones de Python configurando pyenv : https://realpython.com/intro-to-pyenv/

Además, para interactuar con entornos de producción / estadificación, necesitará:

• Heroku cli
• AWS CLI

Ejecutando la construcción local por primera vez

Si está utilizando Docker Desktop, asegúrese de que los recursos: la configuración de intercambio de archivos permita que el directorio clonado se monte en el contenedor web ( mounting las fallas de tiempo de ejecución de OCI al final del paso de compilación).

Comenzar una construcción local se puede hacer ejecutando:

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

Esto iniciará los contenedores en segundo plano, pero no django. Para hacer esto, conéctese al contenedor web con fab sh y ejecute honcho start para iniciar Django y el servidor de desarrollo web de Webpack en primer plano.

Luego, conéctese al contenedor en ejecución nuevamente ( fab sh ) y:

dj createcachetable
dj createsuperuser

El sitio debe estar disponible en la máquina host en: http://127.0.0.1:8000/

Si solo desea ejecutar las herramientas Frontend o Backend, los comandos honcho se ejecuta son docker/Procfile .

Al comenzar el primer contenedor, los archivos estáticos pueden no existir, o pueden estar desactualizados. Para resolver esto, simplemente ejecute npm run build .

Herramientas frontend

Aquí están los comandos comunes:

 # 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

Hay dos formas de ejecutar las herramientas frontend:

• En Docker. Este es el valor predeterminado, más portátil y seguro, pero mucho más lento en macOS.
• O ejecute comandos NPM desde un terminal en su máquina local. Cree un archivo .env en la raíz del proyecto (ver .env.example ) con FRONTEND=local . fab start ya no comenzará un contenedor frontend . Ahora, al ejecutar fab start , Docker no intentará vincularse a los puertos necesarios para el servidor de desarrollo frontend, lo que significa que se pueden ejecutar localmente. Todas las herramientas aún permanecen disponibles en el contenedor.

Instalación de paquetes de Python

Los paquetes de Python se pueden instalar utilizando poetry en el contenedor web:

 fab sh
poetry add wagtail-guide

Para restablecer las dependencias instaladas a cómo están en el archivo poetry.lock :

 fab sh
poetry install --no-root

Despliegues

Para desplegar, fusione su rama de características en la rama master o staging . Una vez que se hayan pasado las tuberías de CI, se implementará en el sitio de Heroku respectivo automáticamente.

Esto se hace a través de la integración de Heroku Github.