EvJava-Muruna

EvaluacionJavaRegistroUsuarios

Este repositorio contiene el código fuente y los recursos asociados a una prueba técnica centrada en la implementación de un sistema de registro de usuarios en Java con SpringBoot.

Índice

Requisitos previos
Estructura del Proyecto
Configuración
Recursos
Instalación
Desarrollo
Uso
Contribuciones
Licencia

Requisitos previos

Para ejecutar este proyecto en su entorno local, debe tener instalado lo siguiente:

Java (versión recomendada 8 o superior)
Spring Boot
Base de Datos (puede ser MySQL, PostgreSQL, H2, etc.)
Gradle o Maven

Configuración

Siga estos pasos para configurar el entorno del proyecto:

Configurar la conexión a la base de datos en el archivo de configuración correspondiente.
Realizar ajustes de configuración adicionales según sea necesario.

Estructura del Proyecto

src/
├── main/
│   ├── java/
│   │   └── com/
│   │       └── ejemplo/
│   │           ├── controller/
│   │           │   # Controladores para la gestión de autenticación y registro
│   │           ├── model/
│   │           │   # Modelos de datos para usuarios, sesiones, respuestas, etc.
│   │           ├── repository/
│   │           │   # Interfaces de repositorio para la persistencia de datos
│   │           ├── service/
│   │           │   # Lógica de negocio y servicios para autenticación y registro
│   │           └── utils/
│   │               # Metodos utiles, como mappers de clases, validaciones personalizadas 
│   └── resources/
│       └── application.properties # Configuración de la aplicación, incluyendo la configuración de la base de datos
├── test/
│   └── java/
│       └── com/
│           └── ejemplo/
│               # Pruebas unitarias y de integración

Recursos

Dentro de la carpeta "recursos", ubicada en la raíz del proyecto, encontrarás tanto la estructura de carpetas del mismo como la documentación Swagger detallada sobre la implementación del registro, una coleccion postman para la prueba de endpoints y un diagrama sencillo uml

Instalación

Siga los siguientes pasos para instalar el proyecto en su entorno local:

Clone el repositorio:

git clone https://github.com/usuario/repo.git

Cambie al directorio del proyecto:

cd EvaluacionJavaRegistroUsuarios

Construya el proyecto utilizando Gradle o Maven:

gradle build

mvn clean install

Asegúrese de configurar la base de datos según las especificaciones del archivo application.properties, en este caso se utiliza una base de datos en memoria H2

Desarrollo

Para ejecutar la aplicación en modo de desarrollo, utilice el siguiente comando:

gradle bootRun

mvn spring-boot:run

Uso

Para iniciar la aplicación, ejecute el siguiente comando:

gradle bootRun

mvn spring-boot:run

El servidor se iniciará en el puerto 8080 por defecto. Puede acceder a la API en http://localhost:8080.

Configure cualquier cliente de prueba de API (por ejemplo, Postman) utilizando la documentación proporcionada en la carpeta "recursos" para probar los endpoints de la API.

Pruebas

Contribuciones

Este proyecto es de código abierto y las contribuciones son bienvenidas. Si desea contribuir, siga estos pasos:

Realice un "fork" del repositorio
Clone su fork en su entorno local
Cree una nueva rama con un nombre descriptivo relacionado con la característica o corrección que desea aportar
Realice sus cambios y envíelos
Abra una solicitud de extracción (pull request) desde su repositorio al repositorio original

Al contribuir al proyecto, asegúrese de seguir las buenas prácticas de desarrollo y las convenciones del código. También es importante mantener una comunicación abierta con el equipo del proyecto, especialmente al discutir nuevas características o cambios significativos en la estructura del código. Trabajar juntos y mantener una comunicación efectiva garantizará que las contribuciones sean valiosas y beneficiosas para el proyecto.

Licencia

Este proyecto está licenciado bajo la Licencia MIT. Siéntase libre de usar, modificar y distribuir el código siguiendo los términos de la licencia.

    /\_/\  
   / o o \ 
  (   "   )

Antonio-112/EvJava-Muruna