Volver al inicio

Primeros Pasos

Instala y ejecuta CodeAtlas en menos de 5 minutos.

Requisitos

  • Node.js 20 o superior
  • npm 10 o superior

Instalación

1 Descarga la aplicación (v0.1.0)

CodeAtlas es una aplicación de escritorio. Elige el instalador de tu sistema operativo en las Releases de GitHub:

  • Linux: .AppImage (o .snap)
  • Windows: instalador .exe o portable .exe
  • macOS: .dmg o .zip

No se requiere Node.js ni npm para usar la aplicación descargada. Los binarios no están firmados: en Windows y macOS se muestra una advertencia al primer arranque (se salta con "Más información → Ejecutar de todas formas" / clic derecho → Abrir).

Para desarrolladores del proyecto

2 Clona el repositorio

$ git clone https://github.com/ingyesid24/CodeAtlas.git
$ cd codeatlas

2 Instala las dependencias

$ npm ci

3 Ejecuta en modo desarrollo

$ npm run electron:dev

Este comando compila el proceso principal, inicia Vite en http://localhost:5173 y abre Electron con recarga en caliente.

Uso básico

Una vez que la aplicación esté ejecutándose:

  1. Haz clic en "Seleccionar proyecto"
  2. Selecciona la carpeta de tu proyecto
  3. CodeAtlas escaneará automáticamente tu código
  4. Explora el mapa interactivo de módulos, el árbol de archivos y los paneles de rutas, dependencias y variables de entorno

Ejecutar pruebas

$ npm test
$ npm run test:watch
$ npm run check

El comando npm run check verifica tipos, ejecuta pruebas y construye la aplicación.

Siguientes pasos