ShopMate Application Documentation

Introduction

Welcome to the ShopMate application documentation. ShopMate is your ultimate e-commerce experience, offering a variety of features for users to explore and shop for products conveniently. This documentation provides an overview of the application's features, installation instructions, usage guidelines, and navigation system.

Features

1. User Authentication

   • Sign up: Users can create new accounts.
   • Sign in: Users can log in using their credentials.
   • Admin Sign in: Admins have a separate login mechanism.

2. User Dashboard

   • After logging in, users are presented with a dashboard.
   • Options in the dashboard include browsing products, changing passwords, accessing inbox, managing the cart, viewing previous orders, and logging out.

3. Product Browsing

   • Users can browse different categories of products.
   • Each category has its manager.

4. Cart Management

   • Users can add products to their cart.
   • They can view and manage items in their cart.
   • Checkout functionality is available.

5. Password Management

   • Users can change their passwords.

6. Messaging System

   • Users can access their inbox.

7. Admin Features

   • Separate login for admin accounts.
   • Admins have access to a dashboard with administrative functionalities.
   • Admins can log in, view statistics, manage products, etc.

8. Input Validation

   • Validation for email format.
   • Ensures email uniqueness during sign-up.

Navigation System

The navigation system of the ShopMate application is designed to provide users with intuitive and easy-to-use functionality. Here's how it works:

1. Main Menu Navigation

   • Users are presented with the main menu upon launching the application.
   • The main menu includes options for signing up, signing in, accessing admin login, or quitting the application.
   • Users can navigate through the main menu using the arrow keys and select options by pressing Enter.

2. Dashboard Navigation

   • Upon successful login, users are redirected to their dashboard.
   • The dashboard contains various options, each representing a specific feature or action within the application.
   • Users can navigate through dashboard options using arrow keys and select actions by pressing Enter.

3. Product Browsing

   • Within the product browsing section, users can navigate through different categories of products.
   • Each category has its navigation interface, allowing users to view products and select items of interest.

4. Cart Management

   • The cart management interface allows users to view and manage items in their cart.
   • Users can navigate through cart options, such as adding or removing items, updating quantities, and proceeding to checkout.

Installation Guide

To install and run the ShopMate application, follow these steps:

1. Clone the repository to your local machine.
2. Open the solution in Visual Studio.
3. Build the solution to restore packages.
4. Set the startup project to the ShopMate project.
5. Run the application.

Usage Guide

1. Sign Up: Create a new account to access the application.
2. Sign In: Log in using your credentials to access your dashboard.
3. Browsing Products: Explore different categories of products available.
4. Cart Management: Add products to your cart, manage cart items, and proceed to checkout.
5. Password Management: Change your password if needed.
6. Messaging System: Access your inbox to view messages.
7. Admin Features: If you're an admin, use the admin login to access administrative functionalities.

Contributing

Contributions to the ShopMate application are welcome! Follow these guidelines to contribute:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them with descriptive messages.
4. Push your changes to your fork.
5. Submit a pull request for review.