H1 Semester Project 2 - Auction Website

H2 Table of Contents

1. H3 About the Project
2. H3 Features
3. H3 Getting Started
   • H4 Prerequisites
   • H4 Installation
4. H3 How to Run the Project Locally
5. H3 How to Use
6. H3 Testing Instructions
7. H3 Contributing
8. H3 License

---

H2 About the Project

"The Auction Platform allows users to create, view, and bid on auctions in a user-friendly interface."

This project is part of Semester Project 2, designed to demonstrate advanced frontend and backend integration. Built using HTML, SCSS, JavaScript, and Bootstrap, it offers a seamless experience for both auctioneers and bidders.

---

H2 Features

H3 Key Functionalities:

• Create Auctions: Users can create auctions with titles, descriptions, images, and tags.
• Browse Auctions: View recently updated auctions, those ending soon, or newest listings.
• Search by Category: Easily find items in specific categories.
• Profile Management: Edit your bio and update your profile image.
• Responsive Design: Works flawlessly on both desktop and mobile.

---

H2 Getting Started

H3 Prerequisites

Ensure you have the following installed:

• Git

H3 Installation

1. Clone the repository:

   git clone https://github.com/ogtrizzy/Semester-Project-2.git
   cd Semester-Project-2

2. Install dependencies npm install

---

H2 How to run the project locally

1. start a local server: visual studio code live server(pathing might not work, dont forget to change pathing to ../ instead of /Semester-Project-2/)
2. open the application in your browser: http://localhost:3000

---

H2 How to use

H3 Create auctions

1. Navigate to the Create Auction page.
2. Fill in the required fields (title, description, end date, and image).
3. Click Submit to publish the auction.

H3 Browse auctions:

1. Use the homepage or category page to explore auctions.
2. Click on an auction to view its details.

H3 Profile Management:

1. navigate to the profile page.
2. update your bio and profile picture.

---

H2 Contributing

Contributions are welcome! Follow these steps:

1. fork the repository.
2. create a new branch:

   git checkout -b feature-name

3. commit your changes and push the branch.
4. Submit a pull request.

---

H2 License

This project is licensed under the MIT License. For more details, see the LICENSE file in the repository.