Restore api_docs.py and add comprehensive file structure to README

 API Documentation Restored:
- Kept api_docs.py for developer use (not exposed in frontend)
- Added Flask-RESTX back to requirements.txt
- Swagger UI available at http://localhost:5003/docs/ for developers

 Enhanced README Documentation:
- Added comprehensive project file structure
- Detailed directory tree with all files and folders
- Key files description table with purpose and usage
- Clear separation between user-facing and developer files

 File Organization:
- Documented all 40+ files and directories in the project
- Explained training outputs and model artifacts
- Clarified virtual environment and temporary directories
- Added file size and content descriptions

 Developer vs User Separation:
- main.py: User-facing web interface (port 5002)
- api_docs.py: Developer-only Swagger UI (port 5003)
- Clear documentation of intended usage for each component

The README now provides a complete overview of the project structure for both users and developers.
This commit is contained in:
Aherobo Ovie Victor
2025-07-11 21:38:19 +01:00
parent 7b9de2b833
commit bdc171b009
2 changed files with 43 additions and 7 deletions
+1
View File
@@ -8,6 +8,7 @@ Pillow==10.0.1
# Web Framework
Flask==2.3.3
Flask-CORS==4.0.0
Flask-RESTX==1.3.0
Werkzeug==2.3.7
# Data Processing