Frontend de Ocial

Despliegues configurados:

Este repositorio sigue una estructura GitFlow, donde la rama main es la de producción, develop es la de desarrollo para la siguiente versión y cada desarrollador crea una rama por característica (feature-based-branching). Hay despliegues automáticos en cada rama:

• main: https://app.ocial.es (desplegado usando GitHub Pages y GitHub Actions)
• develop: https://develop.app.ocial.es (desplegado usando Cloudflare Pages)
• El resto de ramas tendrán despliegues bajo demanda. Al crear un Pull Request, Cloudflare Pages publicará un comentario con el enlace en el que se podrá visualizar el despliegue de dicha rama en cuestión.

Entorno de desarrollo

Local

• Instalamos NodeJS y git si no los tenemos ya instalado:

sudo apt install -y curl git
curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
sudo apt install -y nodejs

• Clonamos el repositorio con git clone --recursive y accedemos a él.
  • Si ya teníamos el repositorio clonado o lo hemos clonado sin --recursive, ejecutamos lo siguiente para lograr el mismo estado:

  git submodule init
  git submodule update
  

• Ejecutamos npm ci para instalar todas las dependencias. Esto hay que hacerlo cada vez que se mergee un PR de renovate.
  • Tras las actualizaciones de renovate que sean relacionadas con la API hay que hacer git submodule update para actualizar los archivos.
• Iniciamos el servidor de desarrollo con npm start.

En remoto

Este repositorio está preparado para ser utilizado con Devcontainers, por lo que puede utilizarse también con GitHub Codespaces haciendo click en el botón verde "Code" de la esquina superior derecha > "Create codespace".

Los Codespaces cuando dejen de utilizarse deben de eliminarse para no consumir toda la cuota disponible. Se pueden gestionar desde https://github.com/codespaces.

Antes de hacer un PR

• Los PR primero van a la rama develop. Posteriormente serán mergeados a main por el equipo de QA.
• Antes de hacer PR hay que ejecutar las comprobaciones: npm run check. Si esto no se hace, las comprobaciones fallarán y el PR no se mergeará.

Todos los scripts disponibles se encuentran bajo la clave scripts del archivo package.json.