ndk-atleos
v2.0.0
Published
Instalador de entorno base para proyectos NDK
Downloads
66
Maintainers
Readme
#NCR ATLEOS
🧱 NDK-Atleos FRAMEWORK
NDK-Atleos es un generador de estructura modular que se integra a proyectos Vite + React, orientado a facilitar el desarrollo segmentado en contextos de equipos. Permite crear módulos con estructura MVC, ejecutar tareas personalizadas y estandarizar flujos de trabajo desde consola.
Instalación
npm install -g ndk-atleosEstructura esperada
Tu proyecto debe tener la siguiente forma mínima:
my-app/
├── src/
│ ├── client/
│ ├── supervisor/
│ ├── aditional/
│ └── ...
├── .vscode/
│ └── tasks.json
└── package.jsonComandos disponibles
ndk help
Muestra una ayuda con los comandos disponibles y recomendaciones generales.
ndk version
Muestra la versión actual instalada del framework.
ndk add screen
Crea una nueva pantalla en el módulo seleccionado. Genera los archivos:
Model/[Nombre].model.tsController/[Nombre].controller.tsxViews/[Nombre].view.tsx
Este comando es interactivo. Te preguntará en qué módulo ubicarlo y el nombre del componente.
ndk create app
Inicializa un nuevo proyecto copiando una plantilla desde lib/templateApp a la carpeta src/.
- Verifica que exista un
package.json. - Requiere que la carpeta
src/esté vacía. - Solicita el nombre de la app y lo guarda en el campo
"app"delpackage.json.
Ejemplo:
ndk create appndk start app
Ejecuta automáticamente todas las tareas definidas como dependencias de la tarea compuesta DevClient en .vscode/tasks.json.
Esto incluye, por ejemplo:
- React Client (
npm run dev:client) - Sass Client (
npm run sass_client) - Soap Mock (
npm run soap) - Cypress, Simulator, etc.
Se ejecuta todo en serie, con spinners informativos y control de errores.
Tareas soportadas (.vscode/tasks.json)
Soporta tareas:
- Tipo
"npm"→ ejecutadas connpm run [script] - Tipo
"shell"→ ejecutadas conexecaenshell: true - Tipo compuesta
"dependsOn"→ comoDevClient,DevSupervisor, etc.
Ejemplo:
{
"label": "DevClient",
"dependsOn": [
"Simulator",
"React Client",
"Cypress",
"Sass Client",
"Soap Mock"
]
}Logo personalizado
Todos los comandos muestran un banner ANSI personalizado:
▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
◄░░░░░░░░░░░░░░░░░░░░▒░░▓██ ░░░░▓ |░░░░▓ ░░░░░░░░▓ ░░░░░ /░░░░░░░░░░░░░░░░░░░►
◄░░░░░░░░░░░░░░░░░▒░░▓██ ░░▓ |░░░░▓ ░░░░ ░░░░░░░▓ ░░░░ /░░░░░░░░░░░░░░░░░►
◄░░░░░░░░░░░░░░▒░░▓██ | ░▓ |░░░░▓ ░░░░░ ░░░░░░▓ ░░░ /░░░░░░░░░░░░░░░►
◄░░░░░░░░░░░▒░░▓██ |░ ░▓ |░░░░▓ ░░░░░░ /░░░░░▓ /░░░░░░░░░░░░░►
◄░░░░░░░░▒░░▓██ |░░ ▓ |░░░░▓ ░░░░░ /░░░░░░▓ ░░░ ░░░░░░░░░░►
◄░░░░░▒░░▓██ |░░░ |░░░░▓ ░░░░ /░░░░░░░▓ ░░░░ ░░░░░░►
◄░░▒░░▓██_|░░░░____ |░░░░▓________/░░░░░░░░▓__░░░░░__░░►
▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
│ N D K - A T L E O S ${version} │
│ by ndk-atleos CLI generator │
└──────────────────────────────────────────────────Con tipografía ANSI Shadow y color anaranjado.
📦 package.json generado
Cuando usás ndk create app, se añade:
"app": "NombreDeLaAplicacion"Esto te permite usarlo desde scripts, entorno o builds personalizados.
💡 Próximamente (ideas)
ndk start supervisoroaditionalndk run-task <nombre>para ejecutar cualquier tarea individualndk list-taskspara mostrar tareas disponibles desde.vscode/tasks.jsonndk generate componentpara elementos visuales más chicos
🛠 Requisitos
- Node.js >= 16
- Tener
npmoyarndisponibles - Proyecto inicializado con
npm inity carpetasrcvacía (paracreate app)
📄 Licencia
MIT © Atleos | desarrollado por Diego Peyrano
