@griddo/cx 10.3.14 → 10.3.16

package/README.md

@@ -1,31 +1,55 @@
-<p align="center">
-  <img src="./gh-assets/griddo-logo.png" alt="Griddo logo" width="280" />
-</p>
-
-Griddo SSG basado en Gatsby.
-
----
-
-## Envs
-
-```bash
-# Bypass the postSearch post feature
-GRIDDO_SEARCH_FEATURE="true"
-# Custom logs
-GRIDDO_BUILD_LOGS="true"
-# Site id to render
-GRIDDO_RENDER_SITE="1234"
-# Render all sites
-GRIDDO_RENDER_ALL_SITES="true"
-# Render page(s) (separated by commas)
-GRIDDO_RENDER_PAGES="1234,56,7788"
-# Number of concurrent connections in API
-GRIDDO_API_CONCURRENCY_COUNT="15"
-# Set the instance name
-GRIDDO_REACT_APP_INSTANCE="instance-name"
-# Asset prefix (only infra)
-GRIDDO_ASSET_PREFIX="prefix"
+# Griddo package
+
+El package `griddo-cx` está dividido en dos carpetas principales: una para la lógica de negocio en `/exporter` y otra para Gatsby (builder) `/src`.
+
+Estas dos carpetas estarían representando dos estados o fases diferenciadas en la ejecución de un "render/build de cx" completo.
+
+1. **Fetching**: Obtención, postprocesado y guardado de los datos en el sistema de archivos.
+
+2. **Rendering** Ejecución de Gatsby para construir los sites utilizando los datos descargados
+
+## 1. Fetching
+
+En la fase de Griddo se desarrolla todo lo necesario para la conexión con API, post-procesado de los datos y generación de JSONS finales de los sites con "un formato Griddo". Aquí es donde se ejecuta la mayor parte de la lógica: obtención de páginas, listados, distribuidores, idomas, etc.
+
+Si hay un requerimiento en CX es muy probable que sea en esta parte donde haya que trabajar.
+
+**Estructura de carpetas**
+
+```text
+| exporter/
+  | adapters/
+    | gatsby/ # Adapta la salida (JSON) de Griddo -> Gatsby
+  | services/
+  | types/
+  | utils/
+  | download-data.ts
+  | build-complete.ts
+  | index.ts
+  | reset-render.ts
+```
+
+## 2. Rendering (Gatsby)
+
+Esta fase se ejecuta inmediatamente después de la primera. Se ejecuta `yarn gatsby build` lo que generá un build utilizando todos los datos que se descargaron en la carpeta `store`.
+
+El código de Gatsby (por ahora el único SSG usado por Griddo) está en la carpeta `./src` junto con los archivos en el root: `gatsby-config.ts`, `gastsby-node.ts`, `gatsby-browser.ts` y `gatsby-ssr.ts`.
+
+```text
+| src/
+  | components/
+    | Head.tsx
+    | template.tsx
+  | htm.tsx
+  | gatsby-node-utils.ts
+  | types.ts
+  | utils.ts
+| gatsby-browser.ts
+| gatsby-config.ts
+| gatsby-node.ts
+| gatsby-ssr.ts
 ```
+
 # Griddo Exporter
 
 El punto de entrada para CX está en `src/index.js` que ejecuta **Griddo Exporter**, publicado en `./build/index.js` del cual podemos encontrar el código TypeScript en `./scripts/griddo-exporter.ts`
@@ -38,7 +62,6 @@ El punto de entrada para CX está en `src/index.js` que ejecuta **Griddo Exporte
 
 Los distintos procesos llamados desde **Griddo Exporter** son:
 
-
 ### API Fetch
 
 **`yarn run api-fetch`**
@@ -57,7 +80,7 @@ Se leen los JSON del store y se crean las páginas pasándolos directamente (0 p
 
 - Se crean Robots
 - Se crean sitemaps.xml del render
-- Se crear un archivo __build_report__info.json para notificar a la API de la finalización del render
+- Se crear un archivo **build_report**info.json para notificar a la API de la finalización del render
 - Se mueven el bundle generado por Gatsby de /public a /dist (esto se debería deprecar)
 
-**`post-build`**
+**`post-build`**