JsIqbal/ecommerce

Ecommerce

Your Comprehensive Guide for the Project

Table of Contents

1. Seed Database
2. Start Application Locally
3. Start Application with Docker

<a name="seed-database"

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:

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:

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:

make seed

• Terminate the make serve terminal and restart the project using

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

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:

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)

{
    "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)

{
    "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)

{
    "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)

{
    "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)

{
    "name": "Iqbal Hossain",
    "email": "zafar.iq3089@gmail.com",
    "phone": "01403229479",
    "status_id": 1,
    "is_verified_supplier": true
}

End-point: Get supplier (Method: GET)

http://localhost:5000/api/suppliers/:id

End-point: Update supplier (Method: PUT)

http://localhost:5000/api/suppliers/:id

Body (raw)

{
    "name": "THE KRAKEN",
    "email": "kraken@gmail.com",
    "phone": "01403229479",
    "status_id": 1,
    "is_verified_supplier": true
}

End-point: Delete supplier (Method: DELETE)

http://localhost:5000/api/suppliers/:id

End-point: Get suppliers (Method: GET)

http://localhost:5000/api/suppliers?page=1&limit=5

Query Params

Param	value
page	1
limit	5

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

Category APIs:

End-point: Create category (Method: POST)

http://localhost:5000/api/categories

Body (raw)

{
    "name": "Android",
    "parent_id": "pef438e9-2c04-4e12-961d-d35e2d75e5cf",
    "status_id": 1
}

End-point: Get category (Method: GET)

http://localhost:5000/api/categories/:id

End-point: Update categories (Method: PUT)

http://localhost:5000/api/categories/:id

Body (raw)

{
    "name": "iphone",
    "status_id": 1
}

End-point: Delete Brand (Method: DELETE)

http://localhost:5000/api/categories/:id

End-point: Get categories (Method: GET)

http://localhost:5000/api/categories?page=1&limit=5

End-point: Get category tree (Method: GET)

http://localhost:5000/api/categories/tree

Query Params

Param	value
page	1
limit	5

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

Thank You!

Thank you for your time and assistance! 🙌 If you have any more questions or need further help, feel free to reach out. Have a great day!