Skip to content

Commit 6443cc4

Browse files
committed
thay đổi readme
1 parent d4e33ac commit 6443cc4

File tree

3 files changed

+71
-143
lines changed

3 files changed

+71
-143
lines changed

.github/workflows/deploy.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ jobs:
2626
npm ci
2727
npm run build
2828
29-
- name: Deploy to GitHub Pages
29+
- name: Upload GitHub Pages artifact
3030
uses: actions/upload-pages-artifact@v3
3131
with:
3232
path: ./build
@@ -40,4 +40,5 @@ jobs:
4040

4141
steps:
4242
- name: Deploy to GitHub Pages
43-
uses: actions/deploy-pages@v4
43+
id: deployment
44+
uses: actions/deploy-pages@v4

README.md

Lines changed: 40 additions & 113 deletions
Original file line numberDiff line numberDiff line change
@@ -1,135 +1,62 @@
1-
# Food Detection & Recipe Generation App - Demo
1+
# Ứng Dụng Nhận Diện Thực Phẩm & Tạo Công Thức Nấu Ăn
22

3-
> AI-powered cooking assistant that detects ingredients from images and generates personalized recipes
3+
## Tổng quan
4+
Ứng dụng AI thông minh giúp nhận diện nguyên liệu từ hình ảnh và tự động tạo ra các công thức nấu ăn phù hợp, hỗ trợ người dùng tận dụng tối đa thực phẩm có sẵn.
45

5-
> Click here to view [demo](https://lockman04.github.io/SavoryAI/)
6-
## Features
6+
## Tính năng chính
77

8-
### 🔍 Smart Ingredient Detection
9-
- **YOLO AI Detection**: Upload photos to automatically identify ingredients
10-
- **Multi-language Support**: English detection with Vietnamese translation
11-
- **Manual Editing**: Fine-tune detected ingredients list
12-
- **Batch Upload**: Process multiple images at once
8+
### Nhận diện nguyên liệu thông minh
9+
- **AI YOLO Detection**: Tải ảnh lên để tự động nhận diện nguyên liệu
10+
- **Chỉnh sửa thủ công**: Điều chỉnh danh sách nguyên liệu đã phát hiện
1311

14-
### Intelligent Recipe Generation
15-
- **3 Recipe Options**: Generate 3 different recipes from same ingredients
16-
- **Vector Database**: Enhanced with similar recipe context
17-
- **Detailed Instructions**: Step-by-step cooking guidance
18-
- **Nutritional Info**: Cooking time, servings, and difficulty level
12+
### Tạo công thức thông minh
13+
- **3 lựa chọn công thức**: Tạo 3 công thức khác nhau từ cùng nguyên liệu
14+
- **Hướng dẫn chi tiết**: Từng bước nấu ăn cụ thể
15+
- **Thông tin dinh dưỡng**: Thời gian nấu, khẩu phần, độ khó
1916

20-
### Interactive Chat Assistant
21-
- **Context-Aware**: Chat knows which recipe you're viewing
22-
- **Recipe-Specific Sessions**: Separate conversations for each dish
23-
- **Real-time Streaming**: Live response generation
24-
- **Quick Questions**: Pre-defined cooking tips and FAQs
17+
### Trợ lý chat tương tác
18+
- **Nhận biết ngữ cảnh**: Chat hiểu công thức đang xem
19+
- **Hội thoại riêng**: Cuộc trò chuyện riêng cho từng món ăn
20+
- **Câu hỏi nhanh**: Mẹo nấu ăn và FAQ có sẵn
2521

26-
### Enhanced User Experience
27-
- **Responsive Design**: Works on desktop, tablet, and mobile
28-
- **Recipe Tabs**: Easy switching between multiple recipes
29-
- **Cooking Tips**: Random tips with falling food icons animation
30-
- **Loading Animations**: Smooth progress indicators
22+
## Công nghệ sử dụng
3123

32-
## Architecture
24+
**Frontend**: React 18+, CSS Animation, Responsive Design
25+
**Backend**: Flask Python, YOLOv11x, Vector Database
26+
**AI/ML**: LM Studio (LLM), ChromaDB, Sentence Transformers
27+
28+
## Kiến trúc hệ thống
3329

3430
```
35-
┌──────────────────┐ ┌─────────────────┐ ┌─────────────────┐
36-
│ React Frontend │ │ Flask Backend │ │ AI Services │
37-
│ │ │ │ │ │
38-
│ • Image Upload │◄──►│ • YOLO Detection│◄──►│ • LM Studio │
39-
│ • Recipe Tabs │ │ • Recipe Gen │ │ • Vector DB │
40-
│ • Chat System │ │ • Chat Sessions │ │ • Embeddings │
41-
└──────────────────┘ └─────────────────┘ └─────────────────┘
31+
React Frontend ↔ Flask Backend ↔ AI Services
32+
↓ ↓ ↓
33+
• Upload ảnh • YOLO Detection • LM Studio
34+
• Recipe Tabs • Tạo công thức • Vector DB
35+
• Chat System • Chat Sessions • Embeddings
4236
```
4337

44-
## Tech Stack
45-
46-
**Frontend**
47-
- React 18+ with Hooks
48-
- Pure CSS with advanced animations
49-
- Lucide React icons
50-
- Responsive design
51-
52-
**Backend**
53-
- Flask Python API
54-
- YOLO v8/v9 for detection
55-
- ChromaDB vector database
56-
- Session management
57-
58-
**AI & ML**
59-
- Local LLM via LM Studio
60-
- Sentence Transformers for embeddings
61-
- Custom trained YOLO model
62-
- Vector similarity search
63-
64-
## Screenshots
65-
66-
### Main Interface
67-
![Main Interface](./screenshots/main-interface.png)
68-
![Reponsive](./screenshots/responsive-design.png)
69-
70-
### Ingredient Detection
71-
![Detection](./screenshots/detection-process.png)
72-
73-
### Cooking Tips
74-
![Tips](./screenshots/cooking-tips.png)
38+
## Ứng dụng thực tế
7539

76-
### Recipe Generation
77-
![Recipes](./screenshots/multiple-recipes.png)
40+
**Người nấu ăn tại nhà**: Biến nguyên liệu ngẫu nhiên thành bữa ăn hoàn chỉnh
41+
**Người yêu ẩm thực**: Khám phá phong cách nấu ăn đa dạng
42+
**Lập kế hoạch bữa ăn**: Sử dụng hiệu quả thức ăn thừa, giảm lãng phí
7843

79-
### Chat Assistant
80-
![Chat](./screenshots/chat-system.png)
44+
## Hiệu suất
8145

82-
## Use Cases
46+
- **Độ chính xác nhận diện**: 85%+
47+
- **Thời gian phản hồi**: <3s cho việc tạo công thức
48+
- **Tính khả dụng**: Mục tiêu 99%+ uptime
8349

84-
### For Home Cooks
85-
- Turn random ingredients into complete meals
86-
- Get cooking advice from AI assistant
87-
- Learn new recipes from available ingredients
50+
## Website demo
8851

89-
### For Food Enthusiasts
90-
- Explore diverse cooking styles
91-
- Understand ingredient combinations
92-
- Improve cooking skills with tips
52+
- [Let me cook](https://lockman04.github.io/SavoryAI/)
9353

94-
### For Meal Planning
95-
- Use leftovers efficiently
96-
- Plan meals based on available ingredients
97-
- Reduce food waste
54+
## Phát triển tương lai
9855

99-
## Future Enhancements
56+
**Tính năng mới**: Chế độ ăn đặc biệt, phong cách ẩm thực, danh sách mua sắm
10057

101-
### Planned Features
102-
- [ ] **Dietary Restrictions**: Vegetarian, vegan, gluten-free options
103-
- [ ] **Cuisine Styles**: Specific cuisine preferences (Asian, Italian, etc.)
104-
- [ ] **Shopping Lists**: Generate ingredient shopping lists
105-
- [ ] **Recipe Rating**: User feedback and recipe improvements
106-
- [ ] **Social Sharing**: Share recipes with friends
107-
- [ ] **Offline Mode**: Local recipe storage and offline access
108-
109-
### Technical Improvements
110-
- [ ] **Performance**: Model optimization and caching
111-
- [ ] **Scalability**: Docker containerization
112-
- [ ] **Security**: Enhanced authentication and authorization
113-
- [ ] **Testing**: Comprehensive unit and integration tests
114-
- [ ] **Analytics**: Usage statistics and user behavior insights
115-
116-
## Performance Metrics
117-
118-
- **Detection Accuracy**: 85%+ ingredient recognition
119-
- **Response Time**: <3s for recipe generation
120-
- **User Satisfaction**: Based on recipe quality and relevance
121-
- **System Uptime**: 99%+ availability target
122-
123-
## Contributing
124-
125-
This is a demo showcase of our food detection application. For the full development version and contribution guidelines, please contact the development team.
126-
127-
## License
128-
129-
This demo is for showcase purposes. Full application licensing terms apply to the complete version.
58+
**Cải tiến kỹ thuật**: Tối ưu hóa hiệu suất, Docker, bảo mật nâng cao
13059

13160
---
13261

133-
**🍳 Made with ❤️ by Vietnamese Developers**
134-
135-
*Last updated: August 2025*
62+
**Made with ❤️ by student of Nguyen Tat Thanh University**

screenshots/README.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,45 @@
1-
# Screenshots Placeholder
1+
# Thư mục Ảnh Chụp Màn Hình
22

3-
This folder contains screenshots showcasing the application features.
3+
Thư mục này chứa các ảnh chụp màn hình minh họa cho các tính năng của ứng dụng.
44

5-
## Required Screenshots
5+
## Các ảnh chụp cần thiết
66

77
### main-interface.png
8-
- Overall application layout
9-
- Left panel with upload area
10-
- Right panel with recipe display
11-
- Clean, modern UI design
8+
- Giao diện tổng thể của ứng dụng
9+
- Bảng bên trái với khu vực tải ảnh
10+
- Bảng bên phải hiển thị công thức nấu ăn
11+
- Thiết kế giao diện hiện đại, sạch sẽ
1212

1313
### detection-process.png
14-
- Image upload interface
15-
- YOLO detection in progress
16-
- Detected ingredients list
17-
- Edit functionality
14+
- Giao diện tải ảnh lên
15+
- Quá trình YOLO đang phát hiện nguyên liệu
16+
- Danh sách nguyên liệu đã nhận diện
17+
- Chức năng chỉnh sửa nguyên liệu
1818

1919
### multiple-recipes.png
20-
- Recipe tabs interface
21-
- 3 different recipe options
22-
- Detailed cooking instructions
23-
- Context enhancement indicator
20+
- Giao diện hiển thị các tab món ăn
21+
- 3 công thức khác nhau được đề xuất
22+
- Hướng dẫn nấu ăn chi tiết
23+
- Chỉ báo tăng cường ngữ cảnh
2424

2525
### chat-system.png
26-
- Chat interface
27-
- Real-time streaming responses
28-
- Quick question suggestions
29-
- Session management
26+
- Giao diện chatbot
27+
- Phản hồi theo thời gian thực
28+
- Gợi ý câu hỏi nhanh
29+
- Quản lý phiên trò chuyện
3030

3131
### cooking-tips.png
32-
- Random tips display
33-
- Falling food icons animation
34-
- Progress indicators
35-
- Loading states
32+
- Hiển thị mẹo nấu ăn ngẫu nhiên
33+
- Hiệu ứng hoạt hình các biểu tượng thực phẩm rơi
34+
- Thanh tiến trình
35+
- Trạng thái đang tải
3636

3737
### responsive-design.png
38-
- Mobile interface
39-
- Tablet layout
40-
- Desktop optimization
41-
- Cross-platform compatibility
38+
- Giao diện trên thiết bị di động
39+
- Bố cục tối ưu cho máy tính bảng
40+
- Tối ưu hóa cho màn hình desktop
41+
- Tương thích đa nền tảng
4242

4343
---
4444

45-
*Screenshots will be generated from the actual running application*
45+
*Ảnh chụp màn hình được tạo từ ứng dụng đang chạy thực tế*

0 commit comments

Comments
 (0)