README.md

Proyecto Observatorios

Este repositorio contiene el cliente del sistema de gestión para observatorios. Su función principal es consumir los endpoints del API de observatorios_crud, permitiendo a los usuarios interactuar con los datos de manera intuitiva y eficiente.

Especificaciones Técnicas

Tecnologías Implementadas

• Vue.js (v3.x): Framework principal para el desarrollo del cliente.
• Vite (v4.x) - Herramienta de construcción rápida
• Vuetify (v3.x) - Framework de UI basado en Material Design
• Pinia (v2.x) - Gestión de estado para Vue 3
• Vue Router (v4.x) - Enrutamiento para Vue 3
• Vuelidate (v2.x) - Validación de formularios
• GSAP (v3.x) - Animaciones avanzadas
• Vitest (v1.x) - Pruebas unitarias
• Axios (v1.x) - Cliente HTTP para peticiones API
• Vue i18n (v9.x) - Internacionalización

---

📂 Estructura del Proyecto

src/
├── assets/                  # Archivos estáticos (imágenes, fuentes, etc.)
├── components/              # Componentes de las vistas principales
├── plugins/                 # Plugins de Vue 
│   └── vuetify.js           # Configuración de Vuetify
├── router/                  # Configuración de Vue Router
│   └── index.js             # Definición de rutas
├── stores/                  # Stores de Pinia
├── views/                   # Vistas/páginas
├── App.vue                  # Componente raíz
└── main.js                  # Punto de entrada de la aplicación

---

🛠 Scripts Disponibles

npm run dev       # Inicia el servidor de desarrollo
npm run build     # Genera la versión lista para producción
npm run test      # Ejecuta las pruebas unitarias con Vitest
npm run lint      # Ejecuta ESLint para verificar la calidad del código

---

Requisitos previos

Antes de comenzar, asegúrate de tener instalado:

• Node.js (versión recomendada: 16+ o 18+)
• npm, pnpm o yarn (gestor de paquetes)

Puedes verificar la instalación de Node.js y npm con los siguientes comandos:

node -v
npm -v

---

Variables de Entorno

---

Ejecución del proyecto

📦 Instalación

Clona el repositorio y accede a la carpeta del proyecto:

git clone https://github.com/udistrital/observatorios_cliente.git
cd observatorios_cliente

Instala las dependencias del proyecto:

npm install

---

🚀 Ejecutar el proyecto en modo desarrollo

Para iniciar el servidor de desarrollo, usa el siguiente comando:

npm run dev

Esto iniciará el proyecto y podrás verlo en tu navegador en:

http://localhost:5173/

---

🏗️ Construcción para producción

Si deseas generar una versión optimizada del proyecto para producción, usa:

npm run build

Esto creará una carpeta dist/ con los archivos listos para ser desplegados en un servidor.

---

Estado CI

Develop	Relese 0.0.1	Master
--	--	--

---

📝 Licencia

This file is part of observatorios_cliente.

observatorios_cliente is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

observatorios_cliente is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with novedades_crud. If not, see https://www.gnu.org/licenses/.