diff --git a/README.md b/README.md new file mode 100644 index 0000000..9950bd7 --- /dev/null +++ b/README.md @@ -0,0 +1,109 @@ +# Premium Car Marketplace - Afghanistan 2026 🇦🇫 +**University Final-Year Project by Mohammad Sadiq** + +Welcome to the **Premium Car Marketplace**, a high-end web application specifically designed for the automotive market in Afghanistan. This project combines modern "Glassmorphism" UI design with a robust PHP backend to provide a seamless car buying and selling experience. + +--- + +## 🚀 Project Overview +This platform is a comprehensive car listing and management system. It features: +- **Hot Deals Section:** Highlighting premium listings on the homepage. +- **Dynamic Browsing:** Search and filter through over 20 detailed car listings across Kabul, Herat, Mazar-i-Sharif, and more. +- **Detailed Specifications:** Each car has a dedicated page with high-quality images and technical details. +- **Contact System:** Integrated messaging for buyers to reach out. +- **Admin Management:** Secure backend for listing control. + +--- + +## 🛠 Tech Stack +- **Backend:** PHP 8.x (Vanilla PHP for high performance) +- **Database:** MariaDB / MySQL (using PDO for secure, prepared statements) +- **Frontend:** HTML5, Custom CSS3 (No Bootstrap - 100% custom Obsidian & Gold design system) +- **Design Pattern:** Glassmorphism (Translucent backgrounds, vibrant accents) +- **Image Sourcing:** Pexels API integration for high-quality automotive visuals. + +--- + +## 💻 How to Run This Project + +### Prerequisites +1. **XAMPP / WAMP / MAMP:** Ensure you have a local server environment installed. +2. **PHP 8.0+** +3. **MySQL/MariaDB** + +### Setup Instructions +1. **Clone the Project:** Place the project folder inside your server's root directory (e.g., `htdocs` for XAMPP). +2. **Database Configuration:** + - Open your PHPMyAdmin. + - Create a new database named `car_marketplace`. + - Import the `db/database.sql` file located in the project folder. + - Verify `db/config.php` matches your local credentials: + ```php + define('DB_HOST', '127.0.0.1'); + define('DB_NAME', 'car_marketplace'); + define('DB_USER', 'root'); + define('DB_PASS', ''); + ``` +3. **Initialize Data:** + - Run the `setup.php` file in your browser (`http://localhost/your-folder/setup.php`) to ensure all tables and demo data are correctly initialized. +4. **Access the Site:** + - Open `http://localhost/your-folder/index.php` in your browser. + +--- + +## 📊 Database Documentation + +### Entity Relationship +The database consists of three primary tables: + +1. **`users`**: Stores user accounts with roles (`admin`, `user`). + - `id`: Primary Key + - `role`: Distinguishes between standard users and site managers. +2. **`cars`**: The core data table. + - `brand`, `model`, `year`, `price`: Primary specifications. + - `city`: Location-based filtering (Kabul, Herat, etc.). + - `is_hot_deal`: Flag for homepage promotion. +3. **`contact_messages`**: Stores inquiries from the contact form. + +### Initial Admin Credentials +- **Email:** `admin@gmail.com` +- **Password:** `12345678` + +--- + +## 📚 Project Monograph (University Report) + +### 1. Abstract +The "Premium Car Marketplace" is a digital solution addressing the lack of centralized, high-quality automotive platforms in Afghanistan. By utilizing a modern tech stack and custom UI design, the project demonstrates how localized software can meet international standards of quality and performance. + +### 2. Introduction +In the current digital age, the automotive industry in Afghanistan relies heavily on social media groups which lack structure and security. This project proposes a centralized web platform that provides structure, verification, and a premium user experience for both buyers and sellers. + +### 3. System Objectives +- **Standardization:** Create a uniform way to list car specifications. +- **Aesthetics:** Implement a "Dark Mode" Obsidian & Gold UI for a premium brand feel. +- **Security:** Use SQL injection prevention and secure password hashing. +- **User Engagement:** Provide interactive elements and smooth transitions. + +### 4. Design Philosophy +The UI follows the **Glassmorphism** trend, which utilizes: +- **Blur Effects:** Creating depth with semi-transparent layers. +- **Vibrant Accents:** Using Gold (`#d4af37`) against Obsidian (`#0f0f12`) for high contrast. +- **Responsiveness:** A custom grid system that works on mobile, tablet, and desktop. + +### 5. Methodology +The project was developed using the **Agile** methodology, starting with a core database schema, followed by modular PHP component development (headers, footers, database helpers), and finally, the implementation of the custom CSS design system. + +### 6. Conclusion +This system proves that high-performance, visually stunning web applications can be built with minimal external dependencies. It serves as a solid foundation for a real-world enterprise application in the Afghanistan tech sector. + +--- + +## 👤 Developer Information +- **Name:** Mohammad Sadiq +- **Project Role:** Full-Stack Developer & UI/UX Designer +- **University Project Year:** 2026 +- **Contact:** admin@gmail.com + +--- +*Note: This project was generated as part of a University Final-Year Project simulation.*