Página Web de Uniformes Odontológicos para DELUXE

Bienvenido al repositorio del sitio web de uniformes para DELUXE, desarrollado utilizando Vite.js y Node.js. Este documento proporciona información sobre cómo configurar y ejecutar el proyecto, así como otros detalles relevantes.

Tabla de Contenidos

1. Requisitos
2. Configuración del Entorno
3. Ejecución del Proyecto
4. Estructura del Proyecto
5. Licencia

Requisitos

Antes de comenzar, asegúrate de tener instalados los siguientes programas:

• Node.js (versión 16 o superior)
• npm (se incluye con Node.js)
• Vite.js (se instalará automáticamente con npm)

Configuración del Entorno

Para que la aplicación funcione correctamente, debes configurar algunas variables de entorno. Crea un archivo .env en la raíz del proyecto y añade las siguientes variables:

# URL de la API
VITE_API_URL=https://tu-api-url.com

# Clave de la API
VITE_API_KEY=tu_api_key

# Documento de identidad (sólo números)
VITE_DOCUMENTO=123456789

# Contraseña
VITE_PASSWORD=tu_contraseña

Asegúrate de reemplazar los valores de ejemplo con tus configuraciones reales.

Ejecución del Proyecto

1. Instala las dependencias necesarias ejecutando:

   npm install

2. En la raíz del proyecto, crea un archivo .env con la configuración adecuada (consulta la sección de Configuración del Entorno).

3. Para iniciar el servidor de desarrollo, utiliza:

   npm run dev

   o, si prefieres usar Yarn:

   yarn dev

4. La aplicación estará disponible en http://localhost:3000 (o el puerto configurado en tu entorno).

Estructura del Proyecto

Este proyecto sigue una arquitectura cliente-servidor, con el front-end desarrollado en Vite.js y la API en Node.js. Puedes encontrar el backend en el siguiente repositorio: DELUXE_Back-end.

Estructura de Carpetas

• index.html: Archivo principal de entrada para la página web.
• assets/: Carpeta que contiene archivos estáticos como imágenes y otros recursos.
• components/: Carpeta para los componentes reutilizables de la interfaz de usuario.
• config/utils/: Carpeta para funciones y utilidades importantes, como la conexión a la API.
• routes/: Carpeta para los archivos de enrutamiento que gestionan las rutas y navegación de la página web.
• states/: Carpeta para archivos relacionados con el estado global de la aplicación y contextos importantes.
• styles/: Carpeta para archivos de CSS y estilos globales.
• views/: Carpeta para las vistas o plantillas de las páginas web.

Licencia

Uso Comercial: Cualquier uso comercial del código requiere una licencia adicional acordada con el autor.

Copyright 2024 Angel Steven Garcia Luna. Todos los derechos reservados.

Este formato incluye:

- Secciones bien definidas y detalladas.
- Ejemplos de comandos y configuraciones en bloques de código.
- Enlaces y referencias a herramientas y recursos relevantes.

Si necesitas ajustes adicionales o más detalles, no dudes en decírmelo.