## 1. Seed Database(locally) - you need to run postgresql locally

To seed the database:

- Configure your `.env` file.
- Navigate to the root of the application.
- Run the following command in the terminal:

```bash
make seed

```

## 1.1. Seed Database(Docker)

To seed the database:

- Configure your `.env` file.
- Navigate to the root of the application.
- Run the following command in the terminal:

```bash
make serve
```

- After executing the command you will be prompt with 2 options:

- option 1: Docker
- option 2: local

- Choose the Docker
- You will see an error saying that connection failed but a db container will be created
- Run the following command in another termianl in the same directory:

```bash
make seed
```

- Terminate the make serve terminal and restart the project using

```bash
make serve
```

# Start Application

To start the application locally

- configure the .env file
- go to root of the application
- run the following command in the terminal

```bash
make serve
```

- After executing the command you will be prompt with 2 options:

- option 1: Docker
- option 2: local

- Choose the Docker
- You will see an error saying that connection failed but a db container will be created
- Run the following command in another termianl in the same directory:

```bash
make seed
```

# API Docs (Swagger Documentation):

- if used docker: http://localhost:5000/docs/index.html
- if used local: http://localhost:8080/docs/index.html

# Brand APIs:

## End-point: Create brand (Method: POST)

```
http://localhost:5000/api/brands
```

### Body (**raw**)

```json
{
"name": "ASUS",
"status_id": 1
}
```

## End-point: Get brand (Method: GET)

```
http://localhost:5000/api/brands/:id
```

## End-point: Update Brand (Method: PUT)

```
http://localhost:5000/api/brands/:id
```

### Body (**raw**)

```json
{
"name": "Lenevo",
"status_id": 1
}
```

## End-point: Delete Brand (Method: DELETE)

```
http://localhost:5000/api/brands/:id
```

## End-point: Get brands (Method: GET)

```
http://localhost:5000/api/brands?page=1&limit=2
```

### Query Parameters:

| Param | value |
| ----- | ----- |
| page | 1 |
| limit | 2 |

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

# Product

## End-point: Create product (Method: POST)

```
http://localhost:5000/api/products
```

### Body (**raw**)

```json
{
"name": "Lenovo Think V2",
"description": "Powerful laptop for professional use.",
"brand_id": "5f2dc58e-d3a8-4580-b4fb-0e72d93f0afe",
"category_id": "8ace9e3f-3bca-4deb-8128-e0f67b0c0924",
"supplier_id": "5d96a2df-370b-4afd-a7c4-cfcc1e7241d2",
"unit_price": 50.05,
"discount_price": 12.54,
"tags": ["business", "professional"],
"status_id": 1,
"stock_quantity": 100
}
```

## End-point: Get product (Method: GET)

```
http://localhost:5000/api/products/:id
```

## End-point: Update product (Method: PUT)

```
http://localhost:5000/api/products/:id
```

### Body (**raw**)

```json
{
"productName": "Lenovo Think V2",
"productDescription": "A powerful laptop designed for professional use.",
"brandId": "5f2dc58e-d3a8-4580-b4fb-0e72d93f0afe",
"categoryId": "8ace9e3f-3bca-4deb-8128-e0f67b0c0924",
"supplierId": "5d96a2df-370b-4afd-a7c4-cfcc1e7241d2",
"unitPrice": 50.05,
"discountPrice": 12.54,
"tags": ["abc", "xyz"],
"statusId": 1,
"stockQuantity": 100
}
```

## End-point: Delete product (Method: DELETE)

```
http://localhost:5000/api/products/:id
```

## End-point: Get products

### Method: GET

```
http://localhost:5000/api/products?page=1&limit=20
```

### Query Params

| Param | value |
| ----- | ----- |
| page | 1 |
| limit | 20 |

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

# Supplier APIs

## End-point: Create supplier (Method: POST)

```
http://localhost:5000/api/suppliers
```

### Body (**raw**)