Spaces:
No application file
No application file
Update README.md
Browse files
README.md
CHANGED
|
@@ -1,103 +1,113 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
|
| 9 |
-
-
|
| 10 |
-
|
| 11 |
-
-
|
| 12 |
-
|
| 13 |
-
|
| 14 |
-
|
| 15 |
-
|
| 16 |
-
|
| 17 |
-
|
| 18 |
-
|
| 19 |
-
|
| 20 |
-
|
| 21 |
-
|
| 22 |
-
|
| 23 |
-
|
| 24 |
-
|
| 25 |
-
|
| 26 |
-
|
| 27 |
-
|
| 28 |
-
|
| 29 |
-
|
| 30 |
-
#
|
| 31 |
-
|
| 32 |
-
|
| 33 |
-
|
| 34 |
-
|
| 35 |
-
|
| 36 |
-
#
|
| 37 |
-
|
| 38 |
-
|
| 39 |
-
|
| 40 |
-
|
| 41 |
-
|
| 42 |
-
|
| 43 |
-
|
| 44 |
-
|
| 45 |
-
|
| 46 |
-
#
|
| 47 |
-
|
| 48 |
-
|
| 49 |
-
|
| 50 |
-
|
| 51 |
-
|
| 52 |
-
|
| 53 |
-
|
| 54 |
-
|
| 55 |
-
|
| 56 |
-
|
| 57 |
-
|
| 58 |
-
|
| 59 |
-
|
| 60 |
-
|
| 61 |
-
|
| 62 |
-
|
| 63 |
-
|
| 64 |
-
|
| 65 |
-
|
| 66 |
-
|
| 67 |
-
|
| 68 |
-
|
| 69 |
-
|
| 70 |
-
|
| 71 |
-
|
| 72 |
-
|
| 73 |
-
|
| 74 |
-
#
|
| 75 |
-
|
| 76 |
-
|
| 77 |
-
|
| 78 |
-
|
| 79 |
-
|
| 80 |
-
|
| 81 |
-
|
| 82 |
-
|
| 83 |
-
|
| 84 |
-
|
| 85 |
-
|
| 86 |
-
|
| 87 |
-
|
| 88 |
-
|
| 89 |
-
|
| 90 |
-
|
| 91 |
-
|
| 92 |
-
|
| 93 |
-
|
| 94 |
-
|
| 95 |
-
|
| 96 |
-
|
| 97 |
-
|
| 98 |
-
|
| 99 |
-
|
| 100 |
-
|
| 101 |
-
|
| 102 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 103 |
- All contributors and maintainers
|
|
|
|
| 1 |
+
---
|
| 2 |
+
title: Multi-Agent E-Commerce Recommender
|
| 3 |
+
emoji: π
|
| 4 |
+
colorFrom: indigo
|
| 5 |
+
colorTo: pink
|
| 6 |
+
sdk: docker
|
| 7 |
+
app_file: main.py
|
| 8 |
+
pinned: false
|
| 9 |
+
---
|
| 10 |
+
|
| 11 |
+
# Multi-Agent E-Commerce Recommendation System
|
| 12 |
+
|
| 13 |
+
A sophisticated recommendation system that uses multiple AI agents to provide personalized product recommendations to users.
|
| 14 |
+
|
| 15 |
+
## Features
|
| 16 |
+
|
| 17 |
+
- Multiple recommendation algorithms (Collaborative Filtering, Content-Based, Sequential Pattern Mining, Hybrid)
|
| 18 |
+
- Real-time user feedback processing
|
| 19 |
+
- Personalized product recommendations
|
| 20 |
+
- Admin dashboard for system monitoring
|
| 21 |
+
- Modern React.js frontend
|
| 22 |
+
- FastAPI backend with async support
|
| 23 |
+
|
| 24 |
+
## Project Structure
|
| 25 |
+
|
| 26 |
+
```
|
| 27 |
+
.
|
| 28 |
+
βββ frontend/ # React.js frontend
|
| 29 |
+
βββ src/
|
| 30 |
+
β βββ api/ # API endpoints and routes
|
| 31 |
+
β βββ algorithms/ # Recommendation algorithms
|
| 32 |
+
β βββ agents/ # AI agents implementation
|
| 33 |
+
β βββ database/ # Database models and connection
|
| 34 |
+
β βββ utils/ # Utility functions
|
| 35 |
+
βββ main.py # Application entry point
|
| 36 |
+
βββ requirements.txt # Python dependencies
|
| 37 |
+
βββ .env # Environment variables
|
| 38 |
+
```
|
| 39 |
+
|
| 40 |
+
## Prerequisites
|
| 41 |
+
|
| 42 |
+
- Python 3.8+
|
| 43 |
+
- Node.js 14+
|
| 44 |
+
- npm or yarn
|
| 45 |
+
|
| 46 |
+
## Setup
|
| 47 |
+
|
| 48 |
+
1. Clone the repository:
|
| 49 |
+
```bash
|
| 50 |
+
git clone <repository-url>
|
| 51 |
+
cd ai-mart
|
| 52 |
+
```
|
| 53 |
+
|
| 54 |
+
2. Set up the backend:
|
| 55 |
+
```bash
|
| 56 |
+
# Create and activate virtual environment
|
| 57 |
+
python -m venv venv
|
| 58 |
+
source venv/bin/activate # On Windows: venv\Scripts\activate
|
| 59 |
+
|
| 60 |
+
# Install dependencies
|
| 61 |
+
pip install -r requirements.txt
|
| 62 |
+
|
| 63 |
+
# Set up environment variables
|
| 64 |
+
cp .env.example .env
|
| 65 |
+
# Edit .env with your configuration
|
| 66 |
+
```
|
| 67 |
+
|
| 68 |
+
3. Set up the frontend:
|
| 69 |
+
```bash
|
| 70 |
+
cd frontend
|
| 71 |
+
npm install
|
| 72 |
+
```
|
| 73 |
+
|
| 74 |
+
## Running the Application
|
| 75 |
+
|
| 76 |
+
1. Start the backend server:
|
| 77 |
+
```bash
|
| 78 |
+
# From the project root
|
| 79 |
+
uvicorn main:app --reload
|
| 80 |
+
```
|
| 81 |
+
|
| 82 |
+
2. Start the frontend development server:
|
| 83 |
+
```bash
|
| 84 |
+
# From the frontend directory
|
| 85 |
+
npm start
|
| 86 |
+
```
|
| 87 |
+
|
| 88 |
+
The application will be available at:
|
| 89 |
+
- Backend API: http://localhost:8000
|
| 90 |
+
- Frontend: http://localhost:3000
|
| 91 |
+
- API Documentation: http://localhost:8000/docs
|
| 92 |
+
|
| 93 |
+
## API Documentation
|
| 94 |
+
|
| 95 |
+
The API documentation is available at `/docs` when running the backend server. It provides detailed information about all available endpoints, request/response formats, and authentication requirements.
|
| 96 |
+
|
| 97 |
+
## Contributing
|
| 98 |
+
|
| 99 |
+
1. Fork the repository
|
| 100 |
+
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
|
| 101 |
+
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
|
| 102 |
+
4. Push to the branch (`git push origin feature/amazing-feature`)
|
| 103 |
+
5. Open a Pull Request
|
| 104 |
+
|
| 105 |
+
## License
|
| 106 |
+
|
| 107 |
+
This project is licensed under the MIT License - see the LICENSE file for details.
|
| 108 |
+
|
| 109 |
+
## Acknowledgments
|
| 110 |
+
|
| 111 |
+
- FastAPI for the amazing backend framework
|
| 112 |
+
- React.js for the frontend framework
|
| 113 |
- All contributors and maintainers
|