Las versiones de las herramientas que necesitas para instalar el software y cómo instalarlas:
- Java: 11 (java-11-openjdk-amd64)
- Maven: Apache Maven 3.6.3
Para correr la aplicación en un entorno local, sigue estos pasos:
- Compila el proyecto y descarga las dependencias necesarias con
mvn clean install
- Corre la aplicación con
mvn spring-boot:run
La aplicación ahora debería estar corriendo en localhost:8080
, a menos que hayas configurado un puerto diferente en tu archivo application.properties
.
Alternativamente, si estás usando Visual Studio Code, puedes correr la aplicación usando el plugin Spring Boot Dashboard.
Para correr las pruebas de la aplicación, abre una terminal en el directorio raíz del proyecto y ejecuta el siguiente comando:
mvn test
Para correr la aplicación sobre docker, sigue estos pasos:
- Compila el proyecto .jar
mvn clean package
- Ejecuta docker-compose
docker-compose build
docker-compose up supermaintenance
Para consumir los diferentes endpoints se debe:
- Crear un usuario a través de 'api/signup' con 'username' y 'password'
- Autenticarte en 'api/signin' con las mismas credenciales para obtener Jwt
(Opcionalmente se puede hacer uso de la colección y entorno para Postman ubicados en el directorio '/postman/')