create-openclass-uniminuto 1.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 William Herrera
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,480 @@
+# create-openclass-uniminuto
+
+Creador de proyectos **Open Class UNIMINUTO** basados en Slidev, con estructura institucional, generación progresiva de **8 semanas**, exportación de recursos y despliegue automático en **GitHub Pages**.
+
+Este repositorio cumple dos funciones:
+
+1. Publicar un paquete npm llamado `create-openclass-uniminuto`.
+2. Servir como base para mantener una plantilla reutilizable de cursos Open Class.
+
+---
+
+
+## Flujo recomendado cuando el repositorio ya existe en GitHub
+
+Este es el flujo pensado para la opción C: primero creas el repositorio en GitHub y luego generas el curso dentro de ese repositorio clonado.
+
+```bash
+git clone https://github.com/herrerawilliamh/openclass-iot.git
+cd openclass-iot
+npm create openclass-uniminuto@latest . -- --iot
+npm install
+npm run semana -- 1
+npm run dev
+```
+
+Si el repositorio no está completamente vacío y quieres reemplazar archivos existentes de la plantilla, usa `--force`:
+
+```bash
+npm create openclass-uniminuto@latest . -- --iot --force
+```
+
+Después sincronizas con GitHub mediante Git, no mediante npm:
+
+```bash
+git add -A
+git commit -m "Configura Open Class IoT"
+git push
+```
+
+`npm create` genera o completa el proyecto; `git push` sincroniza el repositorio y activa GitHub Actions/GitHub Pages.
+
+## 1. Nombres recomendados
+
+### Paquete npm
+
+```json
+"name": "create-openclass-uniminuto"
+```
+
+Uso esperado después de publicarlo:
+
+```bash
+npm create openclass-uniminuto@latest openclass-iot
+```
+
+Con configuración inicial de IoT:
+
+```bash
+npm create openclass-uniminuto@latest openclass-iot -- --iot
+```
+
+La relación es esta:
+
+```text
+Paquete publicado: create-openclass-uniminuto
+Comando de uso  : npm create openclass-uniminuto@latest nombre-del-curso
+```
+
+### Repositorio GitHub del generador npm
+
+```text
+herrerawilliamh/create-openclass-uniminuto
+```
+
+### Repositorio GitHub de la plantilla visual
+
+```text
+herrerawilliamh/openclass-uniminuto-template
+```
+
+Este segundo repositorio puede marcarse como **Template repository** en GitHub para crear cursos desde el botón **Use this template**.
+
+### Repositorios de cursos generados
+
+```text
+herrerawilliamh/openclass-iot
+herrerawilliamh/openclass-bigdata
+herrerawilliamh/openclass-gestion-seguridad
+herrerawilliamh/openclass-percepcion-computacional
+```
+
+URL esperada de GitHub Pages:
+
+```text
+https://herrerawilliamh.github.io/openclass-iot/
+```
+
+---
+
+## 2. Estructura que genera el paquete
+
+```text
+mi-openclass/
+├─ .github/
+│  └─ workflows/
+│     └─ deploy.yml
+├─ config/
+│  ├─ openclass.config.iot-ejemplo.json
+│  └─ openclass.config.iot-desde-openclass-iot.json
+├─ plantillas/
+│  ├─ launcher.md
+│  └─ semana.md
+├─ public/
+│  ├─ descargas/
+│  ├─ fondos/
+│  ├─ imagenes/
+│  └─ videos/
+├─ scripts/
+│  ├─ generar-desde-config.mjs
+│  ├─ nuevo-curso.mjs
+│  ├─ semana.mjs
+│  ├─ preparar-github-pages.mjs
+│  ├─ build-site.mjs
+│  ├─ export-downloads.mjs
+│  └─ decks.mjs
+├─ semanas/
+├─ openclass.config.json
+├─ slides.md
+├─ package.json
+└─ README.md
+```
+
+---
+
+## 3. Tres formas de trabajar
+
+### Opción A · Crear curso desde npm
+
+Útil cuando quieres trabajar desde consola y generar todo el proyecto localmente.
+
+```bash
+npm create openclass-uniminuto@latest openclass-iot -- --iot
+cd openclass-iot
+npm install
+npm run semana -- 1
+npm run dev
+```
+
+Luego creas el repositorio en GitHub y subes el proyecto.
+
+---
+
+### Opción B · Crear curso desde GitHub Template
+
+Útil cuando quieres crear el repositorio primero desde GitHub.
+
+1. Entra al repositorio `openclass-uniminuto-template`.
+2. Clic en **Use this template**.
+3. Crea un repositorio nuevo, por ejemplo `openclass-iot`.
+4. Clónalo en tu equipo.
+5. Ejecuta los comandos del curso.
+
+```bash
+git clone https://github.com/herrerawilliamh/openclass-iot.git
+cd openclass-iot
+npm install
+npm run nuevo
+npm run semana -- 1
+npm run dev
+```
+
+---
+
+### Opción C · Crear repo en GitHub y generar curso en local
+
+Esta es una opción híbrida y recomendada cuando quieres separar el repositorio remoto de la generación local.
+
+Primero creas en GitHub el repositorio `openclass-iot`. Puede ser:
+
+- desde el botón **Use this template**;
+- o como repositorio vacío.
+
+Luego, en local, tienes dos posibilidades.
+
+#### C1. Si el repositorio fue creado desde la plantilla
+
+```bash
+git clone https://github.com/herrerawilliamh/openclass-iot.git
+cd openclass-iot
+npm install
+npm run nuevo
+npm run semana -- 1
+npm run dev
+```
+
+Después subes los cambios:
+
+```bash
+git add -A
+git commit -m "Generar semana 1"
+git push
+```
+
+#### C2. Si el repositorio en GitHub está vacío
+
+```bash
+npm create openclass-uniminuto@latest openclass-iot -- --iot
+cd openclass-iot
+npm install
+npm run semana -- 1
+npm run dev
+```
+
+Luego conectas ese proyecto local con el repositorio remoto:
+
+```bash
+git init
+git branch -M main
+git add -A
+git commit -m "Publicación inicial Open Class IoT"
+git remote add origin https://github.com/herrerawilliamh/openclass-iot.git
+git push -u origin main
+```
+
+Ambas rutas llevan al mismo resultado: un curso Open Class versionado en GitHub y publicable en GitHub Pages.
+
+---
+
+## 4. Publicar este generador en npm
+
+Desde la carpeta de este paquete:
+
+```bash
+npm login
+npm whoami
+npm pack --dry-run
+npm publish --access public
+```
+
+Después de publicar, prueba desde otra carpeta:
+
+```bash
+npm create openclass-uniminuto@latest prueba-openclass
+cd prueba-openclass
+npm install
+npm run semana -- 1
+npm run dev
+```
+
+---
+
+## 5. Subir este generador a GitHub
+
+Crea el repositorio:
+
+```text
+herrerawilliamh/create-openclass-uniminuto
+```
+
+Luego ejecuta:
+
+```bash
+git init
+git branch -M main
+git add -A
+git commit -m "Versión inicial del generador Open Class UNIMINUTO"
+git remote add origin https://github.com/herrerawilliamh/create-openclass-uniminuto.git
+git push -u origin main
+```
+
+---
+
+## 6. Crear el repositorio plantilla de GitHub
+
+El repositorio plantilla debe llamarse preferiblemente:
+
+```text
+openclass-uniminuto-template
+```
+
+Para crearlo, puedes copiar el contenido de la carpeta `template/` como raíz de un nuevo repositorio:
+
+```bash
+mkdir openclass-uniminuto-template
+cp -R template/. openclass-uniminuto-template/
+cd openclass-uniminuto-template
+
+git init
+git branch -M main
+git add -A
+git commit -m "Plantilla Open Class UNIMINUTO"
+git remote add origin https://github.com/herrerawilliamh/openclass-uniminuto-template.git
+git push -u origin main
+```
+
+En GitHub activa:
+
+```text
+Settings → General → Template repository
+```
+
+Con eso podrás crear cursos desde:
+
+```text
+Use this template → Create a new repository
+```
+
+---
+
+## 7. Generar semanas una a una
+
+Cada curso tiene **8 semanas**. El comando principal es:
+
+```bash
+npm run semana -- 1
+```
+
+Ejemplos:
+
+```bash
+npm run semana -- 2 --title "Arquitectura física de soluciones IoT" --date "Junio 15 de 2026"
+```
+
+```bash
+npm run semana -- 3 --title "Protocolos de comunicación" --theme "MQTT, HTTP y comunicación entre dispositivos"
+```
+
+```bash
+npm run semana -- 4 --title "Integración con plataformas en la nube" --activity "Laboratorio guiado" --duration "120 minutos"
+```
+
+Activar solo una semana y desactivar las demás:
+
+```bash
+npm run semana -- 5 --only
+```
+
+Regenerar y sobrescribir el contenido interno de una semana:
+
+```bash
+npm run semana -- 6 --force-content
+```
+
+El comando `semana` actualiza:
+
+```text
+openclass.config.json
+slides.md
+scripts/decks.mjs
+package.json
+curso_semanaN.md
+semanas/curso_semanaN.md
+```
+
+Por defecto conserva el contenido ya editado en `semanas/*.md`.
+
+---
+
+## 8. GitHub Pages
+
+Cada curso generado incluye:
+
+```text
+.github/workflows/deploy.yml
+```
+
+El workflow realiza este proceso:
+
+1. Clona el repositorio.
+2. Configura GitHub Pages.
+3. Instala Node.js.
+4. Ejecuta `npm ci`.
+5. Instala Chromium para exportar PDF/PPTX con Slidev.
+6. Ejecuta `npm run pages:build`.
+7. Sube `dist` como artefacto de GitHub Pages.
+8. Publica el sitio.
+
+En cada repositorio de curso debes activar GitHub Pages así:
+
+```text
+Settings → Pages → Build and deployment → Source → GitHub Actions
+```
+
+Después, cada `git push` a `main` publicará el sitio automáticamente.
+
+---
+
+## 9. Flujo semanal sugerido para un curso
+
+Semana 1:
+
+```bash
+npm run semana -- 1 --title "Introducción al curso"
+git add -A
+git commit -m "Agregar semana 1"
+git push
+```
+
+Semana 2:
+
+```bash
+npm run semana -- 2 --title "Tema de la semana 2"
+git add -A
+git commit -m "Agregar semana 2"
+git push
+```
+
+Repite el proceso hasta la semana 8.
+
+---
+
+## 10. Actualizar el generador en npm
+
+Cambio pequeño:
+
+```bash
+npm version patch
+npm publish
+```
+
+Cambio funcional compatible:
+
+```bash
+npm version minor
+npm publish
+```
+
+Cambio mayor:
+
+```bash
+npm version major
+npm publish
+```
+
+---
+
+## 11. Convenciones recomendadas
+
+| Curso | Repositorio GitHub | Nombre corto sugerido |
+|---|---|---|
+| Internet de las Cosas | `openclass-iot` | `iot` |
+| Big Data | `openclass-bigdata` | `bigdata` |
+| Gestión de Seguridad de la Información | `openclass-gestion-seguridad` | `gsi` |
+| Percepción Computacional | `openclass-percepcion-computacional` | `percepcioncomputacional` |
+
+---
+
+## 12. Resumen operativo
+
+Para publicar el generador:
+
+```bash
+npm publish --access public
+```
+
+Para crear un curso desde npm:
+
+```bash
+npm create openclass-uniminuto@latest openclass-iot -- --iot
+```
+
+Para crear un curso desde GitHub:
+
+```text
+Use this template → openclass-iot
+```
+
+Para generar una semana:
+
+```bash
+npm run semana -- 1
+```
+
+Para publicar en GitHub Pages:
+
+```bash
+git add -A
+git commit -m "Actualizar Open Class"
+git push
+```

package/bin/create-openclass-uniminuto.mjs

@@ -0,0 +1,142 @@
+#!/usr/bin/env node
+import fs from "node:fs";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import { spawnSync } from "node:child_process";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const packageRoot = path.resolve(__dirname, "..");
+const templateRoot = path.join(packageRoot, "template");
+
+const args = process.argv.slice(2);
+const flags = new Set(args.filter((arg) => arg.startsWith("--")));
+const positional = args.filter((arg) => !arg.startsWith("--"));
+const targetArg = positional[0] || "openclass-uniminuto";
+const targetDir = path.resolve(process.cwd(), targetArg);
+const isCurrentDirectoryTarget = targetArg === "." || targetArg === "./";
+const forceOverwrite = flags.has("--force");
+
+function log(message = "") {
+  console.log(message);
+}
+
+function fail(message) {
+  console.error(`\n❌ ${message}\n`);
+  process.exit(1);
+}
+
+function cleanPackageName(value) {
+  return String(value || "openclass-uniminuto")
+    .normalize("NFD")
+    .replace(/[\u0300-\u036f]/g, "")
+    .toLowerCase()
+    .replace(/[^a-z0-9.-]+/g, "-")
+    .replace(/^-+|-+$/g, "") || "openclass-uniminuto";
+}
+
+function copyTemplate(src, dest) {
+  const base = path.basename(src);
+  if (["node_modules", "dist", ".slidev", ".git"].includes(base)) return;
+  const stat = fs.statSync(src);
+  if (stat.isDirectory()) {
+    fs.mkdirSync(dest, { recursive: true });
+    for (const child of fs.readdirSync(src)) {
+      copyTemplate(path.join(src, child), path.join(dest, child));
+    }
+    return;
+  }
+  fs.mkdirSync(path.dirname(dest), { recursive: true });
+  if (fs.existsSync(dest) && !forceOverwrite) {
+    log(`↷ Conservado archivo existente: ${path.relative(targetDir, dest)}`);
+    return;
+  }
+  fs.copyFileSync(src, dest);
+}
+
+function isEffectivelyEmptyProject(dir) {
+  if (!fs.existsSync(dir)) return true;
+  const entries = fs.readdirSync(dir).filter((entry) => ![".git", ".gitkeep"].includes(entry));
+  return entries.length === 0;
+}
+
+function patchJson(filePath, patcher) {
+  if (!fs.existsSync(filePath)) return;
+  const data = JSON.parse(fs.readFileSync(filePath, "utf-8"));
+  patcher(data);
+  fs.writeFileSync(filePath, JSON.stringify(data, null, 2) + "\n", "utf-8");
+}
+
+if (!fs.existsSync(templateRoot)) {
+  fail("No se encontró la carpeta template dentro del paquete npm.");
+}
+
+if (fs.existsSync(targetDir) && !isEffectivelyEmptyProject(targetDir) && !forceOverwrite) {
+  fail(`La carpeta destino ya contiene archivos: ${targetDir}
+
+Para trabajar dentro de un repositorio ya creado en GitHub, usa una carpeta vacía o ejecuta con --force si deseas sobrescribir archivos existentes.
+Ejemplo:
+  npm create openclass-uniminuto@latest . -- --iot --force`);
+}
+
+log("\n┌──────────────────────────────────────────────┐");
+log("│ Crear proyecto Open Class UNIMINUTO · Slidev │");
+log("└──────────────────────────────────────────────┘\n");
+log(`Destino: ${targetDir}`);
+if (isCurrentDirectoryTarget) log("Modo: aplicar plantilla en el directorio actual");
+if (forceOverwrite) log("Modo: --force activo; se podrán sobrescribir archivos existentes");
+
+copyTemplate(templateRoot, targetDir);
+
+const innerName = cleanPackageName(path.basename(targetDir));
+patchJson(path.join(targetDir, "package.json"), (pkg) => {
+  pkg.name = innerName;
+});
+patchJson(path.join(targetDir, "package-lock.json"), (lock) => {
+  lock.name = innerName;
+  if (lock.packages && lock.packages[""]) lock.packages[""].name = innerName;
+});
+
+if (flags.has("--iot")) {
+  const sourceConfig = path.join(targetDir, "config", "openclass.config.iot-desde-openclass-iot.json");
+  const destConfig = path.join(targetDir, "openclass.config.json");
+  if (!fs.existsSync(sourceConfig)) {
+    fail("No se encontró la configuración IoT incluida en la plantilla.");
+  }
+  fs.copyFileSync(sourceConfig, destConfig);
+  log("✓ Configuración IoT aplicada en openclass.config.json");
+
+  const result = spawnSync(process.execPath, ["scripts/generar-desde-config.mjs", "--force"], {
+    cwd: targetDir,
+    stdio: "inherit",
+    shell: false,
+  });
+  if (result.status !== 0) {
+    fail("El generador de configuración no pudo completar el proyecto IoT.");
+  }
+}
+
+if (flags.has("--install")) {
+  log("\nInstalando dependencias con npm install...\n");
+  const result = spawnSync("npm", ["install"], {
+    cwd: targetDir,
+    stdio: "inherit",
+    shell: process.platform === "win32",
+  });
+  if (result.status !== 0) {
+    fail("npm install terminó con error. Revisa la salida de consola.");
+  }
+}
+
+log("\n✅ Proyecto creado correctamente.\n");
+log(`Siguientes pasos:`);
+log(`  cd ${path.relative(process.cwd(), targetDir) || "."}`);
+if (!flags.has("--install")) log("  npm install");
+if (!flags.has("--iot")) log("  npm run nuevo");
+log("  npm run semana -- 1");
+log("  npm run dev");
+log("\nPara activar una semana adicional:");
+log("  npm run semana -- 2 --title \"Título de la semana 2\"");
+log("\nPara revisar la publicación en GitHub Pages:");
+log("  npm run pages:check");
+log("");

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "create-openclass-uniminuto",
+  "version": "1.4.0",
+  "description": "Creador de proyectos Open Class UNIMINUTO basados en Slidev, con generación incremental por semanas y GitHub Pages.",
+  "type": "module",
+  "bin": {
+    "create-openclass-uniminuto": "./bin/create-openclass-uniminuto.mjs"
+  },
+  "files": [
+    "bin",
+    "template",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "slidev",
+    "openclass",
+    "uniminuto",
+    "edtech",
+    "template",
+    "cli"
+  ],
+  "author": "William Herrera",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/herrerawilliamh/create-openclass-uniminuto.git"
+  },
+  "homepage": "https://github.com/herrerawilliamh/create-openclass-uniminuto#readme",
+  "bugs": {
+    "url": "https://github.com/herrerawilliamh/create-openclass-uniminuto/issues"
+  }
+}