LocalArtisan - E Commerce
\nThis documentation outlines the features of the LocalArtisans E-Commerce platform, with a focus on backend and database development.
\nCRUD Operations: Allows users and artisans to perform Create, Read, Update, and Delete actions on the platform. Nearly all features support these operations; for example, artisans can create or add their items to the platform, and they can also update or delete them as needed.
\nUser Registration: Allows users to create an account on the platform.
\nUser Login: Authenticates users and generates a JWT token, enabling access to authenticated services.
\nArtisan Registration: Automatically updates the IsArtisan field in the User table upon successful registration as an artisan.
Add Product to Cart: Adds a product to the user's cart in the database. If the user doesn't have a cart, a new one is created. If the product already exists in the cart, the quantity is updated instead of creating a new entry.
\nCheckout Product: Enables users to purchase a single product in one order, using the \"Buy Now\" feature.
\nCheckout Products in Cart: Allows users to checkout multiple products they have added to their cart.
\nPay Order: Allow the user to pay for an order they placed earlier. Once the order is paid, the quantity of the product will be decreased according to the user’s request.
\nCancel Order: Enable the system to cancel an order if there is a discrepancy between the user and the artisan during the ordering process. The product quantity will be restored to its original amount, and the order will be marked as canceled.
\nUpon login, cookies are generated to enable access to authentication-required services.
\nServices are categorized into two main router groups:
\nBase Service: Accessible without needing cookies.
\nAuth Service: Requires cookies to access.
\nThe IsArtisan attribute in the user table is automatically updated when a user registers as an artisan, with the boolean value changing accordingly.
To ensure security, only authenticated users can access certain services. LocalArtisans uses JWT tokens or cookies for authentication, meaning users must log in to access these services.
\nCheckout Product and Add Product to Cart will only generates if the quantity of product is higher or equal the user request.
\nSecurity and Privacy: The use of JWT tokens or cookies for authentication not only secures user data but also helps in maintaining session privacy and integrity across the platform.
\nFor more information, you can test the features yourself in Postman by downloading or cloning the repository from https://github.com/VincentLimarus/E-Commerce-LocalArtisans/ and importing it into Postman.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"33434480","collectionId":"3492af02-83a7-43f1-bed3-ac5b22a1fdab","publishedId":"2sAXjDfGAW","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-08-22T19:04:43.000Z"},"item":[{"name":"UserServices","item":[{"name":"GetAllUsersService","id":"8bfd0cbf-4ff7-4360-8213-a0ccee8153cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:3000/api/v1/users?page=1&limit=10000&order_by=id&order_type=asc","description":"type GetAllUsersRequestDTO struct {
\nPage int json:\"page\" form:\"page\" binding:\"omitempty\"
Limit int json:\"limit\" form:\"limit\" binding:\"omitempty\"
OrderBy string json:\"order_by\" form:\"order_by\" binding:\"omitempty\"
OrderType string json:\"order_type\" form:\"order_type\" binding:\"omitempty\"
}
type GetUserRequestDTO struct {
ID string json:\"id\" form:\"id\" binding:\"required\"
}
type RegisterUserRequestDTO struct {\n Name string json:\"name\" form:\"name\" binding:\"required\"\n Email string json:\"email\" form:\"email\" binding:\"required\"\n Password string json:\"password\" form:\"password\" binding:\"required\"\n ConfirmPassword string json:\"confirm_password\" form:\"confirm_password\" binding:\"required\"\n IsActive bool json:\"is_active\" form:\"is_active\" binding:\"required\"\n CreatedBy string json:\"created_by\" form:\"created_by\" binding:\"omitempty\"\n}
type LoginUserRequestDTO struct {\n Email string json:\"email\" form:\"email\" binding:\"required\"\n Password string json:\"password\" form:\"password\" binding:\"required\"\n}
type UpdateUserRequestDTO struct {\n ID string json:\"id\" form:\"id\" binding:\"required\"\n Name string json:\"name\" form:\"name\" binding:\"omitempty\"\n Email string json:\"email\" form:\"email\" binding:\"omitempty\"\n PhoneNumber string json:\"phone_number\" form:\"phone_number\" binding:\"omitempty\"\n Address string json:\"address\" form:\"address\" binding:\"omitempty\"\n IsActive bool json:\"is_active\" form:\"is_active\" binding:\"omitempty\"\n UpdatedBy string json:\"updated_by\" form:\"updated_by\" binding:\"omitempty\"\n}
type DeleteUserRequestDTO struct {\n ID string json:\"id\" form:\"id\" binding:\"required\"\n Password string json:\"password\" form:\"password\" binding:\"required\"\n ConfirmPassword string json:\"confirm_password\" form:\"confirm_password\" binding:\"required\"\n}
type ChangePasswordRequestDTO struct {\n ID string json:\"id\" form:\"id\" binding:\"required\"\n OldPassword string json:\"old_password\" form:\"old_password\" binding:\"required\"\n NewPassword string json:\"new_password\" form:\"new_password\" binding:\"required\"\n ConfirmPassword string json:\"confirm_password\" form:\"confirm_password\" binding:\"required\"\n UpdatedBy string json:\"updated_by\" form:\"updated_by\" binding:\"omitempty\"\n}
User Services are divided into 7 main services.
\nGetAllUsersService:
\nFunctionality: Retrieves a list of all users registered in the database.
\nImplementation: Utilizes GORM queries to fetch user data, with support for pagination to manage large datasets effectively.
\nGetUserService:
\nFunctionality: Fetches details of a specific user based on their UserID.
\nImplementation: Uses GORM queries to locate and return user data from the database, ensuring the correct user information is retrieved.
\nRegisterUserService:
\nFunctionality: Handles the registration of new users.
\nImplementation: Adds a new user to the database, ensuring all required information is provided and stored correctly.
\nLoginUserService:
\nFunctionality: Authenticates a user and initiates a session.
\nImplementation: Validates user credentials, generates cookies or JWT tokens, and enables access to authenticated services.
\nUpdateUserService:
\nFunctionality: Updates the information of an existing user.
\nImplementation: Allows users to modify their details, such as name, email, or address, and stores the updated information in the database.
\nDeleteUserService:
\nFunctionality: Removes a user from the database.
\nImplementation: Deletes the user's record, ensuring that their data is no longer accessible within the system.
\nChangePasswordService:
\nFunctionality: Allows users to update their password.
\nImplementation: Verifies the user's current password, then securely updates it to a new one in the database.
\nGetAllArtisansService:
\nFunctionality: Retrieves a list of all artisans registered in the system.
\nImplementation: Utilizes GORM queries to fetch artisan data, with support for pagination to manage large datasets effectively.
\nGetArtisanService:
\nFunctionality: Fetches details of a specific artisan based on their ArtisanID.
\nImplementation: Uses GORM queries to locate and return artisan data from the database, ensuring the correct artisan information is retrieved.
\nRegisterArtisanService:
\nFunctionality: Handles the registration of new artisans.
\nImplementation: Adds a new artisan to the database, ensuring all required information is provided and stored correctly.
\nUpdateArtisanService:
\nFunctionality: Updates the information of an existing artisan.
\nImplementation: Allows artisans to modify their details, such as shop name, shop address, description about the shop, and stores the updated information in the database.
\nDeleteArtisanService:
\nFunctionality: Removes an artisan from the database.
\nImplementation: Deletes the artisan’s record, ensuring that their data is no longer accessible within the system.
\nGetAllCategoriesService:
\nFunctionality: Retrieves a list of all product categories available in the system.
\nImplementation: Utilizes GORM queries to fetch category data, enabling pagination for efficient data handling.
\nGetCategoryService:
\nFunctionality: Fetches details of a specific category based on its CategoryID.
\nImplementation: Uses GORM queries to locate and return category data from the database.
\nCreateCategoryService:
\nFunctionality: Handles the creation of a new category.
\nImplementation: Adds a new category to the database, ensuring proper validation and storage of data.
\nUpdateCategoryService:
\nFunctionality: Updates the information of an existing category.
\nImplementation: Allows for modifications to category details such as name and image, ensuring that updates are saved in the database.
\nDeleteCategoryService:
\nFunctionality: Deletes a category from the database.
\nImplementation: Removes the category’s record, ensuring that it is no longer listed in the available options.
\nGetAllProductService:
\nFunctionality: Retrieves a list of all products available in the system.
\nImplementation: Uses GORM queries with pagination support to manage large datasets of products.
\nGetProductByArtisanService:
\nFunctionality: Fetches all products created by a specific artisan.
\nImplementation: Utilizes GORM to query products by ArtisanID, ensuring correct data retrieval.
\nGetProductByCategoryService:
\nFunctionality: Fetches all products belonging to a specific category.
\nImplementation: Uses GORM queries to filter products based on CategoryID.
\nGetProductService:
\nFunctionality: Retrieves detailed information about a specific product using its ProductID.
\nImplementation: Uses GORM to accurately retrieve and display product details from the database.
\nCreateProductService:
\nFunctionality: Handles the addition of a new product to the system.
\nImplementation: Validates product data and stores the new product in the database.
\nUpdateProductService:
\nFunctionality: Updates details of an existing product.
\nImplementation: Allows product details such as name, price, quantity and description to be modified and stored in the database.
\nDeleteProductService:
\nFunctionality: Removes a product from the database.
\nImplementation: Ensures that the product is no longer available in the system by deleting its record.
\nCheckOutProductService:
\nFunctionality: Handles the checkout process for selected products.
\nImplementation: Manages the checkout flow, including inventory updates and order creation.
\nGetAllPromosService:
\nFunctionality: Retrieves a list of all promotional offers available in the system.
\nImplementation: Uses GORM queries to fetch promo data, supporting pagination for large datasets.
\nGetAllPromoByProductIDService:
\nFunctionality: Fetches all promotional offers associated with a specific product based on its ProductID.
\nImplementation: Utilizes GORM queries to filter promotions by ProductID, ensuring relevant promos are retrieved.
\nGetPromoService:
\nFunctionality: Retrieves detailed information about a specific promotion using its PromoID.
\nImplementation: GORM is used to accurately fetch and display the promo details from the database.
\nCreatePromoService:
\nFunctionality: Handles the creation of new promotional offers.
\nImplementation: Validates promo data and stores the new promotion in the database.
\nUpdatePromoService:
\nFunctionality: Updates the details of an existing promotional offer.
\nImplementation: Allows modifications to the promo details, such as the discount price, and saves the updated information in the database.
\nDeletePromoService:
\nFunctionality: Removes a promotional offer from the system.
\nImplementation: Deletes the promo record, ensuring it is no longer accessible or applied to any products.
\nGetAllReviewsService:
\nFunctionality: Retrieves a list of all product reviews submitted by users.
\nImplementation: Uses GORM queries to fetch review data, supporting pagination for large datasets.
\nGetAllReviewsByProductIDService:
\nFunctionality: Fetches all reviews associated with a specific product based on its ProductID.
\nImplementation: GORM queries are used to filter reviews by ProductID, ensuring all relevant feedback is retrieved.
\nGetReviewByID:
\nFunctionality: Retrieves detailed information about a specific review using its ReviewID.
\nImplementation: GORM is employed to fetch and display the review details from the database accurately.
\nCreateReviewService:
\nFunctionality: Handles the submission of new product reviews by users.
\nImplementation: Validates review data and stores the new review in the database.
\nDeleteReviewService:
\nFunctionality: Removes a review from the system.
\nImplementation: Deletes the review record, ensuring it is no longer accessible or visible to other users.
\nGetAllCartsService:
\nFunctionality: Retrieves a list of all shopping carts in the system.
\nImplementation: Uses GORM queries to fetch cart data, supporting pagination for large datasets.
\nGetCartByUserIDService:
\nFunctionality: Fetches the shopping cart associated with a specific user based on their UserID.
\nImplementation: GORM queries are utilized to retrieve the user's cart, ensuring the correct data is displayed.
\nGetCartByIDService:
\nFunctionality: Retrieves detailed information about a specific cart using its CartID.
\nImplementation: Uses GORM to fetch and display the cart details from the database accurately.
\nCreateCartService:
\nFunctionality: Handles the creation of a new shopping cart for a user.
\nImplementation: Validates cart data and stores the new cart in the database.
\nDeleteCartService:
\nFunctionality: Removes a shopping cart from the system.
\nImplementation: Deletes the cart record, ensuring it is no longer available in the system.
\nCheckoutProductFromCartService:
\nFunctionality: Handles the checkout process for products in a user's cart.
\nImplementation: Handles the checkout process, where the products in the cart are moved directly to the order section.
\nGetAllCartInformationService:
\nFunctionality: Retrieves detailed information for all carts in the system.
\nImplementation: Uses GORM queries to fetch comprehensive cart data, supporting pagination for large datasets.
\nGetAllCartInformationByCartIDService:
\nFunctionality: Fetches detailed information for a specific cart based on its CartID.
\nImplementation: Uses GORM queries to retrieve detailed data for the specified cart.
\nAddItemToCartService:
\nFunctionality: Adds an item to a user's shopping cart.
\nImplementation: Validates item data and updates the cart in the database with the new item.
\nUpdateItemInCartService:
\nFunctionality: Updates the quantity or details of an item in a user's cart.
\nImplementation: Modifies the item data within the cart and saves the updates to the database.
\nDeleteItemInCartService:
\nFunctionality: Removes an item from a user's shopping cart.
\nImplementation: Deletes the item from the cart, ensuring it is no longer listed in the user's cart.
\nGetAllOrderService:
\nFunctionality: Retrieves a list of all orders placed within the system.
\nImplementation: Utilizes GORM queries to fetch order data, supporting pagination for handling large datasets.
\nGetOrderByOrderIDService:
\nFunctionality: Fetches details of a specific order using its OrderID.
\nImplementation: GORM queries are employed to accurately locate and return the order details from the database.
\nGetAllOrderByUserIDService:
\nFunctionality: Retrieves all orders associated with a specific user based on their UserID.
\nImplementation: Uses GORM queries to filter orders by UserID, ensuring all relevant orders for the user are retrieved.
\nGetAllOrderByUserIDAndStatusService:
\nFunctionality: Fetches orders for a specific user filtered by their UserID and order status (e.g., pending, completed).
\nImplementation: GORM is used to filter and fetch orders by both UserID and status, providing more granular order data.
\nDeleteOrderService:
\nFunctionality: Cancels and removes an order from the system.
\nImplementation: Deletes the order record, ensuring that it is no longer accessible or processed.
\nPayOrderService:
\nFunctionality: Handles the payment process for an order.
\nImplementation: Manages payment verification, processing, and updates the order status to 'Paid' upon successful transaction.
\nFinishOrderService:
\nFunctionality: Marks an order as completed after all processes (payment, shipment, etc.) are finalized.
\nImplementation: Updates the order status to 'Completed' and ensures all necessary actions for order fulfillment are recorded.
\nGetAllOrderItemsService:
\nFunctionality: Retrieves a list of all items included in orders across the system.
\nImplementation: Uses GORM queries to fetch order item data, supporting pagination for large datasets.
\nGetOrderItemByIDService:
\nFunctionality: Fetches details of a specific order item using its OrderItemID.
\nImplementation: GORM queries are used to accurately locate and return the order item details from the database.
\nGetAllOrderItemsByOrderIDService:
\nFunctionality: Retrieves all items associated with a specific order based on its OrderID.
\nImplementation: Utilizes GORM queries to filter and fetch items by OrderID, ensuring all items for a particular order are retrieved.
\nGetAllOrderItemsByProductIDService:
\nFunctionality: Fetches all order items associated with a specific product based on its ProductID.
\nImplementation: Uses GORM queries to filter and fetch order items by ProductID, providing data on how often a product has been ordered.
\n