How brucewang15/watclub works
Project Overview & Main Components
• WatClub is a full-stack web application that helps users find and review clubs, design teams, and intramurals at the University of Waterloo.
• The key components include:
• Frontend: A React application (found under the “static” directory) using Redux for state management. It includes UI components for navigation, club search, display pages, profiles, comments, and filtering.
• Backend: A Django RESTful API (with entry points in “manage.py”, “config/settings.py”, and several Django apps such as “comments_and_ratings”, “organizations”, “users”, and “recommendation_system”). Each Django app is responsible for a distinct part of the functionality such as user management, organization handling, and managing reviews.
• Database: SQLite (db.sqlite3) as configured in Django.
• Data Ingestion & Processing: There are modules dealing with data loading and web scraping (“organizations/management/commands”, “webscraping” directories) and even a recommendation system component.
• Containerization & Deployment: Docker files and docker-compose indicate containerized deployment.
Architectural Relationships & Interactions
• The backend is made up of several apps:
• “organizations”: Handles club/organization data (including data loading from JSON files and web scraping),
• “comments_and_ratings”: Manages user feedback and ratings,
• “users”: Manages user authentication, profile settings, and related commands,
• “recommendation_system”: Builds and potentially serves recommendations for clubs.
• The “webscraping” module is used to aggregate data from different sources, and so it should be represented as a component that feeds data into the “organizations” module or an external ETL layer.
• Docker and docker-compose indicate that the entire application (frontend, backend, and possibly data services) can be deployed in containers. This can be depicted around the main components to emphasize container orchestration.