52 lines
1.4 KiB
Markdown
52 lines
1.4 KiB
Markdown
# Product Finder Application
|
|
|
|
A Flask-based web application for finding products through an interactive quiz interface.
|
|
|
|
## Quick Start
|
|
|
|
### 🚀 Running the Application
|
|
|
|
**Option 1: Using VS Code Tasks (Recommended)**
|
|
- Press `Ctrl+Shift+P` → Type "Tasks: Run Task" → Select "Start Flask Server"
|
|
- Open http://127.0.0.1:8080
|
|
|
|
**Option 2: Command Line**
|
|
```bash
|
|
cd app
|
|
python app.py
|
|
```
|
|
|
|
### 📊 Updating Product Data
|
|
|
|
When you update `app/data/products.csv`:
|
|
- Press `Ctrl+Shift+B` to process the data
|
|
- All JSON files will be regenerated automatically
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
📁 app/ - All active project files (application code, assets, data)
|
|
📁 information/ - Documentation and deprecated files
|
|
```
|
|
|
|
See [information/FOLDER_STRUCTURE.md](information/FOLDER_STRUCTURE.md) for detailed organization.
|
|
|
|
## Documentation
|
|
|
|
- **[FOLDER_STRUCTURE.md](information/FOLDER_STRUCTURE.md)** - Complete workspace organization
|
|
- **[QUICKSTART.md](information/QUICKSTART.md)** - Getting started guide
|
|
- **[BITWISE_USAGE_GUIDE.md](information/BITWISE_USAGE_GUIDE.md)** - Bitwise filtering documentation
|
|
- **[START_HERE.md](information/START_HERE.md)** - Project overview
|
|
|
|
## Development
|
|
|
|
All development happens in the `app/` folder. The project uses:
|
|
- **Flask** for the web server
|
|
- **Python** for data processing
|
|
- **Vanilla JavaScript** for the frontend
|
|
|
|
---
|
|
|
|
**Version:** 2.0
|
|
**Last Updated:** March 26, 2026
|