How kixxftw/software-design-ucu-merchandise-hub works
Project type and purpose
• This is a monolithic full-stack Flask web application (“UCU+ Merchandise Hub”) that provides user authentication, student dashboards, e-commerce (shopping cart, payments), admin panel, and integrates with external services (Google OAuth, GCash, Maya, Bank Transfer).
File structure
• Top level:
• run.py – Flask application entry point (WSGI server start, URL routes)
• appwrite.py, models.py, qrcode.py – application logic and data models
• requirements.txt – dependency list
• usersdb.sql – initial database schema
• /static – CSS, JS, images, uploaded product files
• /templates – Jinja2 HTML templates for pages (Index, Dashboard, Payment, Admin, etc.)
• Configuration implied via config.py/.env (database credentials, OAuth keys).
• No separate “frontend” vs “backend” repos: both live in this codebase—typical MVC pattern.
README for additional insights
• Detailed features: authentication (email + Google OAuth), student/instructor roles, shopping cart, order management, payment integrations.
• Technology stack: Flask, Flask-SQLAlchemy, MySQL, Flask-Login, Flask-Migrate, Flask-OAuth, external payment APIs, Jinja2, Bootstrap, jQuery.
Elements
• Labels for each component (e.g., “Flask App (run.py)”, “MySQL DB”, “Google OAuth2”)
• Blue for frontend/browser
• Orange for external APIs
• Gray for storage (filesystem)
• Detail critical flows:
• Authentication flow (local vs. OAuth)
• Checkout/payment flow
• Dashboard data retrieval