Update README.md
This commit is contained in:
parent
953bb4cc8b
commit
aefae7dd64
131
README.md
131
README.md
@ -1,7 +1,126 @@
|
||||
# dealhub
|
||||
# 🚀 DealHub
|
||||
|
||||
Recommendation & Discovery Platform
|
||||
This project is a general recommendation and discovery platform built using Laravel.
|
||||
The goal is to help users discover trusted deals, products, services, places, and tools shared by verified contributors called Brokers.
|
||||
Brokers create recommendation posts (such as deals or useful services), and users explore, search, like, save, and visit these recommendations.
|
||||
The platform highlights trending and high-quality content based on real user interactions.
|
||||
**DelHub** is a **Recommendation & Deal Discovery Platform** built with **Laravel**, where verified brokers share deals and recommendations, and users discover trusted content through likes, favorites, search, and trending logic.
|
||||
|
||||
---
|
||||
|
||||
## 📌 Features
|
||||
|
||||
### 🌐 Public / User
|
||||
|
||||
* View all approved deals and listings
|
||||
* Like ❤️, Favorite ⭐, and Report 🚩 deals
|
||||
* Search deals with category filters
|
||||
* Discover trending, most liked, and recent deals
|
||||
* View broker contact information
|
||||
|
||||
### 🧑💼 Broker
|
||||
|
||||
* Create and manage deal posts
|
||||
* Upload images and external links
|
||||
* Public broker profile with listings
|
||||
* View analytics (views, likes, clicks)
|
||||
* Broker dashboard with performance insights
|
||||
|
||||
### 👑 Admin
|
||||
|
||||
* Manage users and brokers (CRUD)
|
||||
* Login as User/Broker (for support/debugging)
|
||||
* Approve or reject broker listings
|
||||
* Feature or block deals
|
||||
* Admin analytics dashboard
|
||||
|
||||
---
|
||||
|
||||
## 🧱 Tech Stack
|
||||
|
||||
* **Backend:** Laravel
|
||||
* **Frontend:** Blade + Tailwind CSS
|
||||
* **Authentication:** Laravel Breeze
|
||||
* **Database:** MySQL
|
||||
* **Version Control:** Git & GitHub
|
||||
|
||||
---
|
||||
|
||||
## 🗂️ Core Modules
|
||||
|
||||
* Authentication & Role Management
|
||||
* Listings (Deals)
|
||||
* User Interactions (Like, Favorite, Report)
|
||||
* Tracking (Views & Clicks)
|
||||
* Search & Discovery
|
||||
* Broker Profiles & Analytics
|
||||
* Admin Dashboard & Controls
|
||||
* Landing Page (Home, About, Contact)
|
||||
|
||||
---
|
||||
|
||||
## 🖥️ Landing Page Includes
|
||||
|
||||
* Header with navigation
|
||||
* Hero banner
|
||||
* About section
|
||||
* How it works
|
||||
* Contact form
|
||||
* Footer with links
|
||||
|
||||
---
|
||||
|
||||
Used for:
|
||||
|
||||
* Trending deals
|
||||
* Homepage highlights
|
||||
* Category top listings
|
||||
|
||||
---
|
||||
|
||||
## ⚙️ Installation
|
||||
|
||||
```bash
|
||||
git clone https://github.com/your-username/delhub.git
|
||||
cd delhub
|
||||
composer install
|
||||
npm install
|
||||
npm run dev
|
||||
php artisan migrate
|
||||
php artisan serve
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔐 Roles
|
||||
|
||||
* **Admin**
|
||||
* **Broker**
|
||||
* **User**
|
||||
|
||||
Role-based access is handled via middleware.
|
||||
|
||||
---
|
||||
|
||||
## 📈 Future Enhancements
|
||||
|
||||
* Notifications
|
||||
* Deal expiry & auto-hide
|
||||
* API support
|
||||
* Mobile app integration
|
||||
* Advanced analytics charts
|
||||
|
||||
---
|
||||
|
||||
## 👨💻 Author
|
||||
|
||||
**DelHub**
|
||||
Built with ❤️ using Laravel
|
||||
|
||||
---
|
||||
|
||||
If you want, I can also:
|
||||
|
||||
* Shorten this README
|
||||
* Make it more **technical**
|
||||
* Add **screenshots section**
|
||||
* Add **API documentation**
|
||||
* Customize it for **company/internal use**
|
||||
|
||||
Just tell me 👍
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user