💤 YawnMart: The Snooze-Worthy Shopping Experience

Welcome to YawnMart, yet another common, boring e-commerce website. We know the web is full of similar projects, but hey, a GitHub profile isn't complete without one! 😄

Table of Contents

• Introduction
• Features
• Technologies Used
• Setup Instructions
• Project Structure
• Contributing
• License

Introduction

YawnMart is an e-commerce platform that brings you the most mundane shopping experience. It's built as a personal project to showcase my web development skills and to complete my GitHub profile. We might not have reinvented the wheel, but we sure had fun building it! 😴

Features

• 🛒 Product Management: Add, edit, and delete products (yawn).
• 🔐 Authentication: Secure login and registration system (because security is important, even in boring projects).
• 🗂️ Category Management: Organize products into categories (we need some order in the chaos).

Technologies Used

Frontend

• Vue 3: The progressive JavaScript framework for building user interfaces.
• Vue Router: Official router for Vue.js, enabling navigation and route management.
• Tailwind CSS: A utility-first CSS framework for rapid UI development.
• vue-global-loader: A simple and customizable global loading spinner for Vue.js.
• Notivue: A notification library for Vue.js with easy-to-use APIs and customizable components.

Additional Libraries

• clsx: Utility for constructing className strings conditionally.
• tailwind-merge: Utility for merging Tailwind CSS classes.
• Axios: Promise-based HTTP client for the browser and Node.js.

Setup Instructions

Prerequisites

• Node.js (v14 or higher)
• npm (v6 or higher) or yarn (v1 or higher)

Installation

1. Clone the repository:

   git clone https://github.com/Davislyu/YawnMart.git
   cd YawnMart

2. Install dependencies:

   npm install
   # or
   yarn install

3. Run the application:

   npm run dev
   # or
   yarn dev

4. Open your browser and navigate to http://localhost:3000.

Contributing

We welcome contributions from the community! To contribute:

1. Fork the repository.
2. Create a new branch:

   git checkout -b feature/your-feature-name

3. Commit your changes:

   git commit -m "Add some feature"

4. Push to the branch:

   git push origin feature/your-feature-name

5. Create a Pull Request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

---

Thank you for checking out YawnMart! If you have any questions or feedback, feel free to reach out. Happy coding! 🚀

---