Skip to content

Commit cc9a884

Browse files
committed
📄README: add feature roadmap
1 parent 72a376b commit cc9a884

File tree

1 file changed

+43
-32
lines changed

1 file changed

+43
-32
lines changed

frontend/README.md

Lines changed: 43 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,61 @@
11
# Vinted Management Tool
22

3-
A local tool to help manage Vinted seller activities more efficiently.
3+
A local tool to help you manage your Vinted account super fast !
4+
Interface in French only for now.
45

5-
## Features
6+
## Getting Started
67

7-
### Core Features
8+
### Prerequisites for Non-Developers
89

9-
- Automated shipping label management
10-
- Custom thank-you message integration
11-
- Automated buyer communications
12-
- Conversation management
13-
- Feedback automation
14-
- Item database for quick re-listing
15-
- Automated label printing (requires Adobe Reader)
16-
- Sales analytics and accounting exports
10+
Before starting, you'll need to install:
11+
* [Node.js](https://nodejs.org/en/download)
12+
* [Python](https://www.python.org/)
1713

18-
### Email Management
19-
20-
- Automated email sorting and cleanup
21-
- Smart notification handling
22-
23-
## Setup
14+
### First Time Setup
2415

2516
```bash
26-
# Install dependencies
17+
cd frontend
2718
npm install
2819

29-
# Development server
30-
npm run dev
20+
cd ../backend
21+
pip install -r requirements.txt
22+
```
3123

32-
# Production build
24+
### Running the Application
25+
26+
```bash
27+
# Start Frontend (Development)
28+
cd frontend
29+
npm run dev
30+
# OR for Production
3331
npm run build
34-
npm run preview # Preview at http://localhost:4173/
35-
```
32+
npm run preview # Access at http://localhost:4173/
3633

37-
## Important Notes
34+
# Start Backend (in another terminal)
35+
cd backend
36+
fastapi dev main.py
37+
```
3838

39-
- Use a dedicated Vinted email address
40-
- Access token needs periodic renewal (stored in cookies)
41-
- For local use only - no authentication system implemented
42-
- Currently being refactored using Svelte + FastAPI + SQLite
39+
> **Note**: A Docker version might be released in the future to simplify setup for non-developers.
40+
41+
## Features Status
42+
43+
| Feature | Description | Status |
44+
|---------|-------------|--------|
45+
| Conversation Cleanup | Auto-delete conversations after x months of inactivity | ⚒️ Under Refactoring |
46+
| Ad Refresh | Automatic refreshing of listings | ⚒️ Under Refactoring |
47+
| Sales Analytics | Export transactions, generate graphs & statistics | 📝 To Be Done |
48+
| Annual Reports | Yearly compatible reporting system | 📝 To Be Done |
49+
| Favorite Messages | Quick-copy system for 5 favorite messages | 📝 To Be Done |
50+
| Publication Menu | Database-linked posting system with search functionality | 📝 To Be Done |
51+
| Shipping Labels | Automatic retrieval of shipping labels | ⚠️ Not Planned |
52+
| Thank You Messages | Add customizable thank-you messages on shipping labels | ⚠️ Not Planned |
53+
| Feedback System | Random automated feedback for transactions | ⚠️ Not Planned |
54+
| Like Notifications | Auto-send notifications to users who liked an item | ⚠️ Not Planned |
55+
| Auto Purchase Response | Automatic message when a buyer purchases an item | ⚠️ Not Planned |
56+
| Item Database | Auto re upload for items with multiple copies | ⚠️ Not Planned |
4357

4458
## Legal Notice
4559

4660
This tool is for personal use only and must comply with Vinted's terms of service. Any automated data collection must respect platform policies and user privacy.
47-
48-
# start the back
49-
50-
fastapi dev main.py
61+

0 commit comments

Comments
 (0)