https://github.com/daguttt/final_assessment_logistics_warehouse

REST API to manage pallets and loads in a warehouse.
https://github.com/daguttt/final_assessment_logistics_warehouse

Last synced: 6 days ago
JSON representation

REST API to manage pallets and loads in a warehouse.

• Host: GitHub
• URL: https://github.com/daguttt/final_assessment_logistics_warehouse
• Owner: daguttt
• Created: 2024-10-07T19:59:02.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-11-20T00:45:01.000Z (about 1 month ago)
• Last Synced: 2024-11-20T01:28:50.773Z (about 1 month ago)
• Language: Java
• Homepage:
• Size: 271 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Logistics Warehouse API

## Descripción

REST API to manage pallets and loads in a warehouse.

# Repository URL

https://github.com/daguttt/final_assessment_logistics_warehouse

# Project Setup

## 1. Environment variables

1. Copy the [`.env.example`](./src/main/resources/.env.example) file of the `resources/` folder and create the **`.env` file**  in the same folder (`resources/`) **replacing with real variables**.

2. The `JWT_SECRET_KEY` must be an HMAC hash string of 256 bits; otherwise, the token generation will throw an error. **Use [this website](https://www.devglan.com/online-tools/hmac-sha256-online?ref=blog.tericcabrel.com) to generate one**.

> [!TIP]

> Use whichever text for the *"Text to Compute Hash"* and *"Secret Key"* fields in the website.

3. **Emails functionality:** 

   - The `MAIL_PASSWORD` must be an **app password** of your Gmail (*Google*) account. You can generate one in [Google App Passwords](https://myaccount.google.com/apppasswords)

   - The `MAIL_USERNAME` is the **email address** of your Gmail account (e.g. `[email protected]`).

## 2. Database Setup

Create the database named as in the [`.env.example` file](./src/main/resources/.env.example), otherwise running the appication will throw an entityManager error.

## 3. Run the application

You can now safely run the application using your preferred way:

1. Via IDE.

2. Via command line:

    ```bash

    ./mvnw spring-boot:run

    ```

> [!TIP]

> If you get an error running the application, with the Maven command... 

> 

> Make sure to give executable (+x) permissions

> 
chmod ugo+x ./mvnw

>