README.md

app-ecommerce-2023

About

Name: E-Commerce Website
Year: 2023
Info:
Idea:
Description: Project e-commerce website divided into 2 parts (Admin and Store) with Authentication, Authorization, Easy editing of existing products and adding new ones, viewing open orders in the form of a convenient table and graphs, payment processing through the Stripe system and much more.
Deploy:
Admin: https://app-ecommerce-2023-admin.vercel.app/
Store: https://app-ecommerce-2023-store.vercel.app/

Tech stack

Store

Preview:

Admin

Preview:

Workflow

• Introduction
• Environment setup (Admin)
• Clerk Authentication (Admin)
• Modal components (Admin)
• Form components (Admin)
• Prisma, PlanetScale, MySQL setup (Admin)
• Dashboard setup (Admin)
• Navigation bar (Admin)
• Settings page (Admin)
• Billboards Entity (Admin)
• Data Table (Admin)
• Categories Entity (Admin)
• Sizes Entity (Admin)
• Colors Entity (Admin)
• Products Entity (Admin)
• Orders Entity (Admin)
• Environment setup & featured products (Store)
• Individual product screen (Store)
• Individual category screen (Store)
• Product preview modal components (Store)
• Add to Cart functionality (Store)
• Stripe Setup & Checkout finalization (Admin, Store)
• Dashboard page (Admin)
• Dark Mode (Admin)
• Deployment to Vercel (Admin, Store)

API Reference

Stores

Create store

  POST /api/stores

Parameter	Type	Description
userId	auth	Required. User auth from Clerk.

Update store

  PATCH /api/stores/${storeId}

Parameter	Type	Description
userId	auth	Required. User auth from Clerk.
storeId	string	Required. Id of the store to be updated.

Data	Type	Description
name	string	Required. Store name.

Delete store

  DELETE /api/stores/${storeId}

Parameter	Type	Description
userId	auth	Required. User auth from Clerk.
storeId	string	Required. Id of the store to be deleted.

Billboards

Get all billboards

  GET /api/${storeId}/billboards

Parameter	Type	Description
storeId	string	Required. Id of the store to be deleted.

Create billboard

  POST /api/${storeId}/billboards

Parameter	Type	Description
userId	auth	Required. User auth from Clerk.
storeId	string	Required. Id of the store to be deleted.

Data	Type	Description
label	string	Required. Billboard label.
imageUrl	string	Required. Billboard image URL.

Get billboard

  GET /api/${storeId}/billboards/${billboardId}

Parameter	Type	Description
storeId	string	Required. Id of the store.
billboardId	string	Required. Id of the store billboard.

Update billboard

  POST /api/${storeId}/billboards/${billboardId}

Parameter	Type	Description
userId	auth	Required. User auth from Clerk.
storeId	string	Required. Id of the store.
billboardId	string	Required. Id of the store billboard to be updated.

Data	Type	Description
label	string	Required. Billboard label.
imageUrl	string	Required. Billboard image URL.

Delete billboard

  DELETE /api/${storeId}/billboards/${billboardId}

Parameter	Type	Description
userId	auth	Required. User auth from Clerk.
storeId	string	Required. Id of the store.
billboardId	string	Required. Id of the store billboard to be deleted.

Categories

Get all categories

  GET /api/${storeId}/categories

Parameter	Type	Description
storeId	string	Required. Id of the store.

Create category

  POST /api/${storeId}/categories

Parameter	Type	Description
userId	auth	Required. User auth from Clerk.
storeId	string	Required. Id of the store.

Data	Type	Description
name	string	Required. Category name.
billboardId	string	Required. Billboard for this category.

Get category

  GET /api/${storeId}/categories/${categoryId}

Parameter	Type	Description
storeId	string	Required. Id of the store.
categoryId	string	Required. Id of the store category.

Update category

  PATCH /api/${storeId}/categories/${categoryId}

Parameter	Type	Description
userId	auth	Required. User auth from Clerk.
storeId	string	Required. Id of the store.
categoryId	string	Required. Id of the store category to be updated.

Data	Type	Description
name	string	Required. Category name.
billboardId	string	Required. Billboard for this category.

Delete category

  DELETE /api/${storeId}/categories/${categoryId}

Parameter	Type	Description
userId	auth	Required. User auth from Clerk.
storeId	string	Required. Id of the store.
categoryId	string	Required. Id of the store category to be deleted.

Colors

Get all colors

  GET /api/${storeId}/colors

Parameter	Type	Description
storeId	string	Required. Id of the store.

Create color

  POST /api/${storeId}/colors

Parameter	Type	Description
userId	auth	Required. User auth from Clerk.
storeId	string	Required. Id of the store.

Data	Type	Description
name	string	Required. Color name display.
value	string	Required. Color value.

Get color

  GET /api/${storeId}/colors/${colorId}

Parameter	Type	Description
storeId	string	Required. Id of the store.
colorId	string	Required. Id of the store color.

Update color

  PATCH /api/${storeId}/colors/${colorId}

Parameter	Type	Description
userId	auth	Required. User auth from Clerk.
storeId	string	Required. Id of the store.
colorId	string	Required. Id of the store color to be updated.

Data	Type	Description
name	string	Required. Color name display.
value	string	Required. Color value.

Delete color

  DELETE /api/${storeId}/colors/${colorId}

Parameter	Type	Description
userId	auth	Required. User auth from Clerk.
storeId	string	Required. Id of the store.
colorId	string	Required. Id of the store color to be deleted.

Sizes

Get all sizes

  GET /api/${storeId}/sizes

Parameter	Type	Description
storeId	string	Required. Id of the store.

Create size

  POST /api/${storeId}/sizes

Parameter	Type	Description
userId	auth	Required. User auth from Clerk.
storeId	string	Required. Id of the store.

Data	Type	Description
name	string	Required. Size name display.
value	string	Required. Size value.

Get size

  GET /api/${storeId}/sizes/${sizeId}

Parameter	Type	Description
storeId	string	Required. Id of the store.
sizeId	string	Required. Id of the store size.

Update size

  PATCH /api/${storeId}/sizes/${sizeId}

Parameter	Type	Description
userId	auth	Required. User auth from Clerk.
storeId	string	Required. Id of the store.
sizeId	string	Required. Id of the store size to be updated.

Data	Type	Description
name	string	Required. Size name display.
value	string	Required. Size value.

Delete size

  DELETE /api/${storeId}/sizes/${sizeId}

Parameter	Type	Description
userId	auth	Required. User auth from Clerk.
storeId	string	Required. Id of the store.
sizeId	string	Required. Id of the store size to be deleted.

Products

Get all products

  GET /api/${storeId}/products

Parameter	Type	Description
storeId	string	Required. Id of the store.
categoryId	string	Filter by store category Id.
colorId	string	Filter by store color Id.
sizeId	string	Filter by store size Id.
isFeatured	boolean	Filter by store isFeatured value.

Create product

  POST /api/${storeId}/products

Parameter	Type	Description
userId	auth	Required. User auth from Clerk.
storeId	string	Required. Id of the store.

Data	Type	Description
name	string	Required. Product name.
price	string	Required. Product price.
categoryId	string	Required. Product category id.
colorId	string	Required. Product color id.
sizeId	string	Required. Product size id.
images	[{url:string}]	Required. Array with image Url(s).
isFeatured	boolean	Required. Boolean value whether to display the product on the main page.
isArchived	boolean	Required. Boolean importance of whether to archive this product.

Get product

  GET /api/${storeId}/products/${productId}

Parameter	Type	Description
storeId	string	Required. Id of the store.
productId	string	Required. Id of the store product.

Update product

  PATCH /api/${storeId}/products/${productId}

Parameter	Type	Description
userId	auth	Required. User auth from Clerk.
storeId	string	Required. Id of the store.
productId	string	Required. Id of the store product to be updated.

Data	Type	Description
name	string	Required. Product name.
price	string	Required. Product price.
categoryId	string	Required. Product category id.
colorId	string	Required. Product color id.
sizeId	string	Required. Product size id.
images	[{url:string}]	Required. Array with image Url(s).
isFeatured	boolean	Required. Boolean value whether to display the product on the main page.
isArchived	boolean	Required. Boolean importance of whether to archive this product.

Delete product

  DELETE /api/${storeId}/products/${productId}

Parameter	Type	Description
userId	auth	Required. User auth from Clerk.
storeId	string	Required. Id of the store.
productId	string	Required. Id of the store product to be deleted.

Checkout

Get header options

  OPTIONS /api/${storeId}/checkout

Parameter	Type	Description
storeId	string	Required. Id of the store.

Create invoice

  POST /api/${storeId}/checkout

Parameter	Type	Description
storeId	string	Required. Id of the store.
invoice	Stripe object	Required. Stripe invoce object.

Webhook

Stripe Webhook

  POST /api/webhook

ASCII

 .d8b.  d8888b. d8888b.        d88888b  .o88b.  .d88b.  .88b  d88. .88b  d88. d88888b d8888b.  .o88b. d88888b        .d888b.  .d88b.  .d888b. d8888b. 
d8' `8b 88  `8D 88  `8D        88'     d8P  Y8 .8P  Y8. 88'YbdP`88 88'YbdP`88 88'     88  `8D d8P  Y8 88'            VP  `8D .8P  88. VP  `8D VP  `8D 
88ooo88 88oodD' 88oodD'        88ooooo 8P      88    88 88  88  88 88  88  88 88ooooo 88oobY' 8P      88ooooo           odD' 88  d'88    odD'   oooY' 
88~~~88 88~~~   88~~~   C8888D 88~~~~~ 8b      88    88 88  88  88 88  88  88 88~~~~~ 88`8b   8b      88~~~~~ C8888D  .88'   88 d' 88  .88'     ~~~b. 
88   88 88      88             88.     Y8b  d8 `8b  d8' 88  88  88 88  88  88 88.     88 `88. Y8b  d8 88.            j88.    `88  d8' j88.    db   8D 
YP   YP 88      88             Y88888P  `Y88P'  `Y88P'  YP  YP  YP YP  YP  YP Y88888P 88   YD  `Y88P' Y88888P        888888D  `Y88P'  888888D Y8888P' 

License

MIT