📘 CourierSync - Sistema Web para Optimización de Procesos Logísticos

---

🛠️ Stack tecnológico y Arquitectura

---

👤 Autor

👨‍💻 Nombre	📧 Correo	🏫 Link directo al repositorio	🐙 Usuario GitHub
Jonathan David Fernandez Vargas	jonathanfdez62@gmail.com	LinkRepositorio	jonathand77

---

1. 🔍 Introducción

CourierSync es un sistema web orientado a optimizar los procesos de transporte y distribución de la empresa, incrementando la eficiencia operativa, reduciendo tiempos de gestión y mejorando la experiencia del cliente mediante automatización, trazabilidad y análisis de datos en tiempo real.

Este repositorio corresponde al frontend desarrollado con Next.js, TypeScript y Tailwind CSS, enfocado en la Feature 4: Control de Inventario en Tránsito.

---

2. 🎯 Objetivo General

Desarrollar un sistema web que optimice los procesos logísticos de transporte y distribución, facilitando la gestión de paquetes en tránsito con una experiencia de usuario clara, rápida y escalable.

---

3. 📋 Funcionalidades Principales

Feature 4. Control de Inventario en Tránsito

• Monitoreo de paquetes en todas las etapas del transporte para minimizar pérdidas y errores.
• Autenticación y Autorización: acceso exclusivo para personal de almacén y logística.
• Registro de Paquetes (CRUD): ingreso y modificación de datos de paquetes en tránsito (código, estado, ubicación).
• Actualización de Ubicación (CRUD): registro de la ubicación actual del paquete mediante escaneo o GPS.
• Alerta de Incidencias: notificación inmediata ante extravíos, daños o retrasos detectados.
• Reporte de Inventario: resumen del estado actual del inventario en tránsito.

---

4. ⚙️ Tecnologías Utilizadas

💻 Frontend

• Next.js
• Tailwind CSS
• TypeScript
• Iconos (especificar la librería de iconos usada, por ejemplo, Lucide React o Font Awesome)

---

5. 📦 Estructura del Proyecto

App/
│
├───components/          # Componentes de la interfaz de usuario
│   ├───Login.tsx        # Componente para la vista de inicio de sesión
│   ├───Menu.tsx         # Componente para el menú de navegación
│   ├───Registro.tsx     # Componente para la vista de registro de usuarios
│   └───Inventario.tsx   # Componente para la vista de gestión de inventario

---

6. 🚀 Despliegue

• Integración Continua/Entrega Continua (CI/CD): GitHub Actions
• Plataforma de Despliegue: Vercel

---

7. 🖥️ Guía Paso a Paso para la Ejecución

7.1 Requisitos Previos

• Node.js instalado en tu sistema.
• npm o yarn instalado.
• Acceso a un repositorio de GitHub (para clonar el proyecto).
• Vercel CLI (opcional, para despliegue local y pruebas).

7.2 Clonar el Repositorio

Abre tu terminal y ejecuta:

git clone https://github.com/Jonathand77/courier-sync-code-factory
cd courier-sync-code-factory

7.3 Instalar Dependencias

npm install
# o
yarn install

7.4 Configurar Variables de Entorno (si es necesario)

Si tu proyecto requiere variables de entorno (como claves de API, URLs de bases de datos, etc.), crea un archivo .env.local en la raíz del proyecto y define las variables necesarias. Por ejemplo:

NEXT_PUBLIC_API_URL=http://localhost:3000/api

Asegúrate de consultar la documentación del proyecto o los archivos de configuración para conocer las variables específicas que se requieren.

7.5 Ejecutar la Aplicación en Desarrollo

npm run dev
# o
yarn dev
# o
pnpm dev
# o
bun dev

Abre http://localhost:3000 con tu navegador para ver el resultado.

Puedes empezar a editar la página modificando app/page.tsx. La vista se actualiza automáticamente conforme guardas cambios.

7.6 Despliegue en Vercel (Opcional)

• Instalar Vercel CLI (si no lo has hecho):

npm install -g vercel
# o
yarn global add vercel

• Iniciar sesión en Vercel:

vercel login

• Desplegar el proyecto:

vercel

Vercel te guiará en el proceso de configuración y despliegue. Asegúrate de que vercel.json esté correctamente configurado.

• Previsualizar el proyecto localmente:

vercel dev

---

8. ⚙️ GitHub Actions

El proyecto está configurado con GitHub Actions para CI/CD. Cada cambio en el repositorio puede disparar automáticamente procesos de validación y despliegue en Vercel.

• Workflow: definido en .github/workflows/main.yml (o similar).
• Acciones típicas del workflow:
  • npm install o yarn install
  • npm run build o yarn build
  • vercel deploy --prebuilt
• Despliegue automático: configurado para ejecutarse en push a la rama principal (o la rama definida por tu estrategia).
• Estado del workflow: visible en la pestaña Actions del repositorio en GitHub.

---

9. 🤝 Contribución

Si eres parte de Fábrica Escuela, las contribuciones son bienvenidas.

1. Haz un fork del repositorio.
2. Crea una rama para tu funcionalidad (git checkout -b mi-funcionalidad).
3. Haz commit de tus cambios (git commit -am 'Agrega nueva funcionalidad').
4. Sube los cambios a la rama (git push origin mi-funcionalidad).
5. Crea un Pull Request.

---

10. 📄 Licencia

Este proyecto está licenciado bajo la licencia MIT. Revisa el archivo LICENSE para más detalles.

---

11. 🎁 Agradecimientos

• Comparte este proyecto con otras personas 📢
• Da las gracias públicamente 🤓

---

12. 📚 Recursos

• Documentación oficial de Next.js
• Aprende Next.js
• Repositorio de Next.js en GitHub
• Documentación de despliegue de Next.js

---

Fin de la guía del proyecto CourierSync.