📝 Update README
Browse files
README.md
CHANGED
|
@@ -1,10 +1,90 @@
|
|
| 1 |
---
|
| 2 |
-
title:
|
| 3 |
-
emoji:
|
| 4 |
-
colorFrom:
|
| 5 |
-
colorTo:
|
| 6 |
sdk: docker
|
|
|
|
| 7 |
pinned: false
|
| 8 |
---
|
| 9 |
|
| 10 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
+
title: LocalLend
|
| 3 |
+
emoji: 🏘️
|
| 4 |
+
colorFrom: blue
|
| 5 |
+
colorTo: green
|
| 6 |
sdk: docker
|
| 7 |
+
app_port: 7860
|
| 8 |
pinned: false
|
| 9 |
---
|
| 10 |
|
| 11 |
+
# LocalLend - Community Item Sharing Platform
|
| 12 |
+
|
| 13 |
+
LocalLend is a community-driven platform that connects neighbors to share items and build trust within their local community.
|
| 14 |
+
|
| 15 |
+
## 🌟 Features
|
| 16 |
+
|
| 17 |
+
- **Item Listing & Browsing**: Browse available items in your community
|
| 18 |
+
- **Smart Search & Filters**: Filter by category, condition, and ratings
|
| 19 |
+
- **Booking System**: Request to borrow items with date management
|
| 20 |
+
- **Rating System**: Rate items and users to build community trust
|
| 21 |
+
- **User Profiles**: View user trust scores and borrowing history
|
| 22 |
+
- **Secure Authentication**: JWT-based authentication system
|
| 23 |
+
- **Image Management**: Upload and manage item images via Cloudinary
|
| 24 |
+
|
| 25 |
+
## 🛠️ Tech Stack
|
| 26 |
+
|
| 27 |
+
**Backend:**
|
| 28 |
+
- Spring Boot 3.5.6
|
| 29 |
+
- Java 17
|
| 30 |
+
- MongoDB for data persistence
|
| 31 |
+
- JWT for authentication
|
| 32 |
+
- Cloudinary for image storage
|
| 33 |
+
|
| 34 |
+
**Frontend:**
|
| 35 |
+
- React 19
|
| 36 |
+
- TypeScript
|
| 37 |
+
- Material-UI (MUI)
|
| 38 |
+
- Vite build tool
|
| 39 |
+
|
| 40 |
+
## 🚀 Getting Started
|
| 41 |
+
|
| 42 |
+
This application is automatically deployed from the GitHub repository and runs on Hugging Face Spaces.
|
| 43 |
+
|
| 44 |
+
### Test Credentials
|
| 45 |
+
You can use these test accounts to explore the platform:
|
| 46 |
+
- **Username**: `fasd@gmail.com`
|
| 47 |
+
- **Password**: `12345678`
|
| 48 |
+
|
| 49 |
+
## 📝 How to Use
|
| 50 |
+
|
| 51 |
+
1. **Register/Login**: Create an account or login with test credentials
|
| 52 |
+
2. **Browse Items**: View available items on the home page
|
| 53 |
+
3. **Filter & Search**: Use filters to find specific items
|
| 54 |
+
4. **Book Items**: Click on an item to view details and create a booking
|
| 55 |
+
5. **Manage Bookings**: View and manage your bookings from the dashboard
|
| 56 |
+
6. **Rate & Review**: After completing a booking, rate the item and owner
|
| 57 |
+
|
| 58 |
+
## 🔧 Environment Variables
|
| 59 |
+
|
| 60 |
+
The following environment variables are configured as Hugging Face Secrets:
|
| 61 |
+
- `MONGODB_URI`: MongoDB connection string (MongoDB Atlas)
|
| 62 |
+
- `JWT_SECRET`: Secret key for JWT token generation
|
| 63 |
+
- `CLOUDINARY_CLOUD_NAME`: Cloudinary cloud name
|
| 64 |
+
- `CLOUDINARY_API_KEY`: Cloudinary API key
|
| 65 |
+
- `CLOUDINARY_API_SECRET`: Cloudinary API secret
|
| 66 |
+
|
| 67 |
+
## 📦 Project Structure
|
| 68 |
+
|
| 69 |
+
```
|
| 70 |
+
locallend/
|
| 71 |
+
├── backend/ # Spring Boot backend
|
| 72 |
+
│ ├── src/
|
| 73 |
+
│ └── pom.xml
|
| 74 |
+
├── frontend/ # React frontend
|
| 75 |
+
│ ├── src/
|
| 76 |
+
│ └── package.json
|
| 77 |
+
└── Dockerfile # Multi-stage build for deployment
|
| 78 |
+
```
|
| 79 |
+
|
| 80 |
+
## 🤝 Contributing
|
| 81 |
+
|
| 82 |
+
This project is part of an academic project for Object-Oriented Analysis and Design (OOAD) course.
|
| 83 |
+
|
| 84 |
+
## 📄 License
|
| 85 |
+
|
| 86 |
+
This project is for educational purposes.
|
| 87 |
+
|
| 88 |
+
---
|
| 89 |
+
|
| 90 |
+
**Deployed on Hugging Face Spaces** | Auto-deployed via GitHub Actions
|