Warehouse

This is a Java REST API that runs a warehouse software.

This software holds articles, and the articles contain an identification number, a name and available stock. It is possible to load articles into the software from a file, see inventory.json.

The warehouse software also have products, products are made of different articles. Products have a name, price, and a list of articles of which they are made from with a quantity. The products also loaded from a file initially, see products.json.

Getting Started

Prerequisites

Java 11 - Programming language

Running the tests

./mvnw test

Running the application

./mvnw spring-boot:run

Run dockerized

./mvnw spring-boot:build-image
docker run -p 8080:8080 docker.io/library/warehouse:0.0.1-SNAPSHOT

API endpoint documentation: http://localhost:8080/api/swagger-ui/

Access Credentials

User role can only inquire entities.

User: user
Password: userPassword

Admin has all the rights including saving new products, articles and selling products.

User: admin
Password: adminPassword

Built With

Spring Boot - The framework used
Maven - Dependency management
JUnit - Test framework
Spring Security - Authentication and access-control framework
Swagger - Used to generate API docs & UI

Author

Baris Aydinoglu

barisaydinoglu/warehouse