Story

As a customer, I Want to register in the system.

Customer Data

• FirstName
• LastName
• Email
• Is Suspend (default active)
• Phone Number (optional)
• Password
• Last Login
• TimeStamps

API

Method: POST
Endpoint api/customer/register
Request: All Data in Customer Data Section except Last Login and Is Suspended
Response: Successful message

AC:

• Customer password must be at least 8 character and contains upprtcase, lowercase, number
• Customer Model

Checklist

• API Doc
• Test

Story

As an admin, I Want to delete a customer

API

Method: DELETE
Endpoint api/admin/customer/{id}
Auth: admin
Response:
- Successful Message

Checklist

• API Doc
• Test

Story

As an admin, I want to get customer list

API

Method: GET
Endpoint api/admin/customers
Auth: admin
Request: page, limit
Response:

• Paginator with customer model data without password

Checklist

• API Doc
• Test

Story

As an admin, I Want to create a customer

API

Method: POST
Endpoint api/admin/customer
Auth: admin
Request: FirstName, LastName, Email,Is Suspend (optional - default active), Phone Number (optional), Password
Response:
- customer model except password field

Checklist

• API Doc
• Test

Story

The system must have a model for future image relations like category, product, and maybe customers, ...

Imageable Data

PolyMorphic Images!

AC

• model-based relation
• image path
• type

Checklist

• Test

Story

The system must have a model for Cart and CartItem

Cart Data

• id
• customer email
• customer firstname
• customer lastname
• customer id
• shipping method
• items_count
• item_qty
• grand total
• subtotal
• shipping cost
• discount amount
• is active
• timestamps

Cart Items Data

• id
• qty
• name
• price
• cart id
• product id
• timestamps

Checklist

• Test

Story

As System Admin - I want to create an Admin user with the artisan command

Admin Data

• FirstName
• LastName
• Email
• Status (default is 1)
• Phone Number (optional)
• Password
• Last Login
• TimeStamps

Command

Params: Email and password (optional)

AC:

• If password is not provided, Create a random password and show it to the user

Checklist

• #8

Story

The system must have a model for Categories

Category Data

• id
• name
• slug
• position (category order)
• image_relation (find a way to make a relation between this category and imageable)
• parent_id
• status (default enable)
• meta title (optional)
• meta description (optional)
• meta keywords (optional)
• timestamps

AC

• For images find a way to use the image gallery(#16)

Checklist

• Test

Story

As an admin, I Want to login into the system.

API

Method: POST
Endpoint api/admin/login
Request: Email, Password
Response:
- bearer token
- expires_at

AC:

• Using sanctum as the authentication package ( with a different guard)
• Last Login changes
• If provided email or password is wrong show a general message and don't expose which one is wrong!

Checklist

• API Doc
• Test

Story

As an admin, I Want to create a category

API

Method: POST
Endpoint api/admin/category
Auth: admin
Request Data:

• id
• name
• slug
• position (category order)
• image
• parent_id
• status (default enable)
• meta title (optional)
• meta description (optional)
• meta keywords (optional)

Response:
- Category Model

AC

• If slug is not provided, it must be generated automatically
• Image must be stored at public\images\categories

Checklist

• API Doc
• Test

Task

Each product in the system must have a unique stock-keeping unit (SKU)

AC

• SKU must be unique
• by default SKU can be generated from the product name

Story

As a customer, I Want to logout from the system,

API

Method: GET
Endpoint api/customer/logout
Auth: customer
Request: empty
Response: Successful message

AC:

• Token must be useless if we use it in another guarded request.
• Other customer tokens must be there and just the requested one gets revoked

Checklist

• API Doc
• Test

Story

As a customer, I Want to login into the system.

API

Method: POST
Endpoint: api/customer/login
Request: Email, Password
Response:

• bearer token
• expires_at

AC:

• Using sanctum as the authentication package
• Last Login changes
• If provided email or password is wrong show a general message and don't expose which one is wrong!

Checklist

• API Doc
• Test

Story

As an admin, I Want to create a product

API

Method: POST
Endpoint api/admin/product
Auth: admin
Request Data:

• name
• slug
• short description
• description
• images
• categories
• status (default enable)
• meta title (optional)
• meta description (optional)
• meta keywords (optional)
• price
• sale price(optional)
• sale start(optional)
• sale end(optional)

Response:
- Product Model

AC

• If slug is not provided, it must be generated automatically
• Image must be stored at public\images\products

Checklist

• API Doc
• Test

Story

The system must have a model for Product

Product Data

• id
• name
• slug
• short_description
• description
• position (product order) (optional)
• image_relation (find a way to make a relation between this product and imageable)
• category_relation
• status (default enable)
• meta title (optional)
• meta description (optional)
• meta keywords (optional)
• price
• sale price(optional)
• sale start(optional)
• sale end(optional)
• timestamps

AC

• For images find a way to use the image gallery(#16)
• Products can have multiple categories!

Checklist

• Test

Story

As an admin, I Want to edit a customer

API

Method: PUT
Endpoint api/admin/customer/{id}
Auth: admin
Request: FirstName, LastName, Email,Is Suspend (optional - default active), Phone Number (optional), Password
Response:
- customer model except for password field

Checklist

• API Doc
• Test