Skip to content

7vk/despensa-rest-api

 
 

Repository files navigation

Milestone hacktoberfest


DeepSource Docker Pulls Docker Image Version Twitch nmarulo

Despensa-app - REST API

Descripción

Despensa-app es una aplicación que te permite gestionar los productos que compras de forma habitual.

Este proyecto proporciona los recursos a consumir por el proyecto web.

Características
  • Ver/Crear/Modificar/Eliminar listas
  • Listas publicas
  • Listas por usuario (privadas)
  • Agregar productos a la lista
  • Filtrar productos
  • Ver información de un producto
  • Marcar productos de la lista
  • Crear usuario
  • Autenticación
  • Autorización JWT
  • Administración (Pendiente)

Despliegue local

Requisitos

Empezar a trabajar

Crear base de datos

  • Creamos un usuario llamado despensa_app con la siguiente contraseña despensa_app.
  • Creamos el esquema despensa_app.
  • Automáticamente, al iniciar spring se ejecutarán los scripts schema.sql y data.sql

Usando postman

  • Puedes hacer un fork a las API en el siguiente enlace:

    Run In Postman

Trabajando en IntelliJ IDEA

Clonar proyecto:

File > New > Project from Version Control

Establecer la ruta local de maven:

(No es necesario si se pretende usar mvnw)

File > Settings > Build, Execution, Deployment > Build Tools > Maven

  • maven home path

Compilar:

  • Run > Run...
    • [spring-boot:run]: Inicia el proyecto.
    • [clean,install]: Compila el proyecto sin test.
    • [clean,install] Tests: Compila ejecutando los test.

Ejecutar aplicación:

  • Run > Run...

    • App

    Si el usuario y contraseña, de la base de datos, es distinto a root, modificar la información de conexión del fichero src/main/resources/application.properties

Habilitar EditorConfig

  • Es necesario tener habilitado el soporte de EditorConfig:

    Settings > Editor > Code Style

    • Enable Editor Config Support

Establecer acciones de guardado

  • Recomiendo tener activado las acciones de guardado:
    • Reformat code
    • Optimize imports

Settings > Tools > Actions on save

Tener habilitado EditorConfig.

Spring-boot-devtools

  • Activar la compilación automática del proyecto:

Settings > Build, Execution, Development > Compiler

  • Build project automatically

Contribuir

Cualquier contribución que hagas será muy apreciada.

Agradecimientos

Gracias a JetBrains por proporcionar una licencia para IntelliJ IDEA para desarrollar este proyecto.

JetBrains IntelliJ IDEA
JetBrains logo IntelliJ IDEA logo

Licencia

MIT license.

Releases

No releases published

Packages

No packages published

Languages

  • Java 98.0%
  • Dockerfile 2.0%