README_es.md

Portal Web de SCRUM LATAM Comunidad

Repositorio del Portal Web de Scrum Latam Comunidad.

English

El nuevo portal Web de SCRUM LATAM Comunidad usa tecnologías Plone 6 y Volto.

Inicio rápido

Stack de desarrollo

• Python 3.9, 3.10, 3.11
• Node 16
• yarn
• Docker

Instalación

Instale las dependencias de requisitos, ejecutando el siguiente comando:

sudo apt install build-essential python3-dev python3-venv git tree curl

Descargar e instalar Node Version Manager - NVM, ejecutando el siguiente comando:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash

Configurando el script nvm en entornos de consola para usarlo, ejecutando el siguiente comando:

export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")" \
   [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"

Para reflejar los cambios del script nvm en los entornos de terminal para usarlo, ejecute el siguiente comando:

source ~/.bashrc && exit

Inicie la terminal nuevamente y continúe con la ejecución de los siguientes comandos.

Instalar Node 16 Version:

Descargar e instalar la versión de Node 16, ejecutando el siguiente comando:

nvm install 16

Habilite la versión de Node 16 a usar, ejecutando el siguiente comando:

nvm use 16

Instalar la herramienta yarn tool, ejecutando el siguiente comando:

npm install --global yarn

Clonar e instalar el repositorio git, ejecutando el siguiente comando:

git clone git@github.com:ScrumLATAMComunidad/scrumlatamcomunidad.com.git scrumlatamcomunidad-com && cd $_

Instalar el stack de desarrollado, ejecutando el siguiente comando:

make install

Iniciar

Abra dos consolas para ejecutar cada uno de los siguientes comandos en cada una de ellas:

Iniciar el Backend (http://localhost:8080/)

make start-backend

Iniciar el Frontend (http://localhost:3000/)

make start-frontend

Ayuda

Para obtener más información detallada sobre las tareas disponibles para el comando make, ejecute el siguiente comando:

make help

Estructura

Este repositorio monolítico por dos bases de código distintas: api (backend) y frontend.

• backend: Instalación de API (Backend) Plone usando pip (no buildout). Incluye un paquete de políticas denominado slc_web. Más información detallada en el archivo backend/src/slc_web.
• devops: Scripts de despliegues Devops para este repositorio monolítico. Más información detallada en el archivo devops/README.md.
• frontend: Paquete React (Volto) llamado frontend. Más información detallada en el archivo frontend/README.md.

Razonamiento

• El repositorio contiene todo el código base necesario para ejecutar el portal (excluyendo complementos existentes para Plone y React).
• Los flujos de trabajo de Github se activan en función de los cambios en cada base de código (ver el directorio .github/workflows)
• Más fácil de crear imágenes de Docker para cada base de código
• Instalación/configuración de Showcase Plone sin compilación

Linters y formateo

Hay algunos ganchos para ejecutar controles de pelusa en el código. Si desea formatearlos automáticamente, puede ejecutar

make format

en la carpeta raíz o específicamente en cada carpeta de backend o frontend.

Los comandos de Linters están disponibles en cada carpeta de backend y frontend.

Pruebas de aceptación

Hay comandos Makefile en su lugar:

build-test-acceptance-server: Construir la imagen Docker de aceptación del servidor backend que se está utilizando después. Debe ejecutarse antes de ejecutar las pruebas, si el código de backend ha cambiado.

build-test-acceptance-server: Build Acceptance Backend Server Docker image that it's being used afterwards. Must be run before running the tests, if the backend code has changed.

start-test-acceptance-server: Inicie el servidor fixture en Docker (construcción previa es requerida)

start-test-acceptance-frontend: Inicie los Fixture de Frontend de aceptación del Core en modo desarrollador

test-acceptance: Inicie las pruebas de aceptación de Core Cypress en modo desarrollo

Contributors

Leonardo J. Caballero G. 🐛 🚧 🚇 📖 🔧 🛡️ 💬 🌍 💻 ⚠️ 📓 📆 👀 🤔	Humberto R Hansen. 🔍 🐛 🚧 🚇 🛡️ 📖 🔧 💬 🎨 🌍 💻 📓 👀 🤔	Manuel Matos 🐛 🎨 🌍 💻 ⚠️ 📓	Juan Lopez 🐛 🎨 💻 🌍 📓	Ruben Dario Romero Chica 💼 🧑‍🏫 📋 🔍 🐛 📖 🖋 💬 📆 🤔	Emilia Miranda 🐛 📖 🖋 💬 📆 🤔
Vanessa Apaza 🐛 📖 🖋 💬 📆 🤔	Lizbeth Martel 🐛 📖 🖋 💬 📆 🤔	Enny Infante 🐛 📖 🖋 💬 📆 🤔

Este proyecto sigue la especificación all-contributors. ¡Contribuciones de cualquier tipo son bienvenidas!

Para ver solo los colaboradores del código fuente, consulte los gráficos de los contribuyentes.

Créditos

Esto fue generado por cookiecutter-plone-starter el 11-05-2023 04:07:02

Licencia

Licenciado bajo la GNU GENERAL PUBLIC LICENSE Version 2, para obtener más detalles, consulta el archivo LICENSE.