How tomngo03/group_study works
Project type and purpose
• This is a full-stack Django web application (“StudyHub”/“Study Group Assistant”) that provides an interactive study companion.
• It hosts both HTML + JS front-end components (Django templates + static assets) and a back-end API layer (Django views + DRF serializers) and integrates with an external OpenAI conversational API.
File structure
• Top-level “study_group” directory: Django project configuration (settings.py, urls.py, ASGI/WSGI entrypoints).
• “study_project” directory: the core Django app containing:
• models.py, migrations/ → ORM data models (User, Task, Room, etc.)
• views.py, forms.py, templates/study_project/ → view logic + HTML templates
• api/serializers.py, api/views.py, api/urls.py → REST API endpoints
• utils.py & load_test.py → helper functions (e.g. OpenAI API wrapper)
• static/ & templates/ & theme/: shared frontend assets (CSS, JS, images) and base HTML.
• db.sqlite3: development database
• private.key: (probably for secure tokens, OAuth credentials)
• manage.py: Django CLI entrypoint
README for additional insights
• Confirms Django framework + OpenAI API integration for chatbot features
• Highlights key features: user registration & login, multiple study topics, chat interface, back-end migrations, and settings for OPENAI_API_KEY
Elements
• Labels for each component (Browser, Django Router, Template View, API View, ORM, Database, OpenAI API)
• HTTP requests/responses
• DB reads/writes
• External API calls
• Blue for user-facing components (templates, static)
• Green for back-end modules (views, models, utils)
• Orange for external systems (OpenAI API, OAuth)
Detailed separation of components
• “study_group” project container: settings, URL router, ASGI/WSGI
• “study_project” app container:
• models.py + migrations
• forms.py + views.py (HTML)
• api/serializers.py + api/views.py (REST)
• utils.py (OpenAI wrapper)
• Static & Template directories: CSS, JS, images, common layouts
• Database server
• External OpenAI service