82 lines
2.1 KiB
Markdown
82 lines
2.1 KiB
Markdown
# Workspace Folder Structure
|
|
|
|
This workspace is organized into clean, logical folders:
|
|
|
|
## 📁 Root Directory
|
|
|
|
```
|
|
├── .env.example # Environment configuration template
|
|
├── .gitignore # Git ignore rules
|
|
├── .vscode/ # VS Code settings and tasks
|
|
├── app/ # 🚀 Active project files (MAIN APPLICATION)
|
|
└── information/ # 📚 Documentation and deprecated files
|
|
```
|
|
|
|
## 🚀 app/ - Active Project Files
|
|
|
|
**All working application code and assets**
|
|
|
|
- **app.py** - Main Flask application
|
|
- **config.py** - Application configuration
|
|
- **wsgi.py** / **passenger_wsgi.py** - Production WSGI servers
|
|
- **requirements.txt** - Python dependencies
|
|
- **parse_csv_to_json.py** - CSV to JSON data processor
|
|
- **generate_bitwise_helper.py** - Bitwise filtering data generator
|
|
- **css/** - Stylesheets
|
|
- **js/** - JavaScript files
|
|
- **templates/** - HTML templates
|
|
- **data/** - JSON data files
|
|
- **images/** - Image assets
|
|
|
|
## 📚 information/ - Documentation
|
|
|
|
**All project documentation and guides**
|
|
|
|
- AI_PARSING_INSTRUCTIONS.md
|
|
- BITWISE_USAGE_GUIDE.md
|
|
- QUICKSTART.md
|
|
- README.md
|
|
- REQUIRED_CODE_CHANGES.md
|
|
- START_HERE.md
|
|
- URL_EXAMPLES.md
|
|
- URL_IMPLEMENTATION_SUMMARY.md
|
|
- URL_STATE_MANAGEMENT.md
|
|
|
|
### information/deprecated/ - Old Files
|
|
|
|
**Deprecated files kept for reference**
|
|
|
|
- index.html / index2.html (replaced by templates/)
|
|
- codes.text (old data)
|
|
- run.bat (old batch file)
|
|
- Procfile (old deployment config)
|
|
- temp/ (temporary files)
|
|
|
|
---
|
|
|
|
## Working with the Project
|
|
|
|
### Running Tasks
|
|
|
|
All VS Code tasks are configured to work with the new structure:
|
|
|
|
- **Ctrl+Shift+B** - Process All Data (updates JSON from CSV)
|
|
- **Ctrl+Shift+P** → "Tasks: Run Task" → "Start Flask Server"
|
|
|
|
### Updating Data
|
|
|
|
When you update `app/data/products.csv`:
|
|
1. Press **Ctrl+Shift+B** to run "Process All Data"
|
|
2. This generates fresh JSON files in `app/data/`
|
|
|
|
### Starting the Server
|
|
|
|
1. Press **Ctrl+Shift+P**
|
|
2. Type "Tasks: Run Task"
|
|
3. Select "Start Flask Server"
|
|
4. Open http://127.0.0.1:8080
|
|
|
|
---
|
|
|
|
**Last Updated:** March 26, 2026
|