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 (v1.4.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.

Instalación por plataforma

Linux

Descarga el archivo CodeAtlas-1.4.0.AppImage desde las Releases de GitHub.
Dale permisos de ejecución (en la terminal, dentro de la carpeta donde lo descargaste):
$ chmod +x CodeAtlas-1.4.0.AppImage
Ejecútalo:
$ ./CodeAtlas-1.4.0.AppImage
La primera vez, la app se integra sola en el menú de aplicaciones de GNOME: crea un launcher estable en ~/.local/bin/codeatlas, su entrada .desktop e ícono. Como el acceso apunta al launcher (y no al AppImage versionado), las actualizaciones automáticas no rompen el menú.

La versión .snap se distribuye mediante Snap Store y se actualiza por ese canal, no por GitHub Releases.

Windows

Descarga el instalador CodeAtlas Setup 1.4.0.exe (NSIS) o el portable CodeAtlas 1.4.0.exe.
Instalador: ejecútalo y sigue el asistente. CodeAtlas quedará en el menú de inicio.
Portable: abre el archivo y úsalo directamente, sin instalar nada.

Los binarios no están firmados: SmartScreen puede mostrar una advertencia la primera vez. Sáltala con "Más información → Ejecutar de todas formas".

macOS

Descarga el archivo CodeAtlas-1.4.0.dmg (o el .zip).
Ábrelo y arrastra el ícono de CodeAtlas a la carpeta Applications.
Lanza CodeAtlas desde Applications.

Los binarios no están firmados: Gatekeeper puede bloquear la primera apertura. Clic derecho sobre la app → "Abrir" para saltarlo.

¿El acceso del menú quedó roto tras una actualización? En versiones anteriores a la v1.4.0, el acceso de Linux apuntaba a un AppImage con nombre versionado que cambia al actualizar. Descarga el AppImage actual desde las Releases de GitHub, ejecútalo una vez y la app regenerará el launcher estable y el acceso correctos.

Actualizaciones

Desde la v1.4.0, CodeAtlas comprueba automáticamente si hay una versión nueva al iniciar y te avisa dentro de la app. También puedes usar el botón "Buscar actualizaciones" en la cabecera.

Al detectar una versión nueva aparece un aviso con la versión disponible y el botón "Descargar actualización"
La descarga muestra su progreso en tiempo real
Al terminar, elige "Reiniciar e instalar" para completar la actualización

Si tienes v0.1 o v1.1: esas versiones no incluyen el actualizador. Instala una vez manualmente la v1.4.0 desde las Releases de GitHub. Desde esa versión, las futuras actualizaciones se notificarán automáticamente.

El sistema usa electron-updater con GitHub Releases como proveedor. En Linux, la versión .snap se actualiza mediante Snap Store.

Uso básico

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

Haz clic en "Seleccionar proyecto"
Selecciona la carpeta de tu proyecto
CodeAtlas escaneará automáticamente tu código
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.