How se701-group6/a2 works
Main Components
• Frontend (Web App):
• Built in React, located in the "split-webapp/split" directory.
• Uses Material-UI for user interface elements.
• Includes pages (Home, Login, SignUp, Split details, and Transactions) and components (AuthorizedRoute, MenuBar, etc.).
• Backend (Server):
• Implemented in Python with CherryPy as the web server framework.
• Key files include main.py, server.py, and several API endpoint modules (account.py, bill_data.py, bill_exec.py, pay_exec.py), which indicate an API-driven design.
• Incorporates a lightweight DB manager that connects with SQLite.
• Database:
• SQLite is used as the database.
• Deployment/CI-CD:
• Presence of Dockerfile, .dockerignore, and GitHub Actions workflows for testing and deployment indicates automation and containerization practices.
Detail the Relationships and Interactions
• Optionally, show that the deployment pipeline (GitHub workflows and Docker) supports the continuous integration & delivery aspects of both the Frontend and Backend.
Architectural Patterns & Design Principles
• Separation of Concerns: Clearly divide the system into a client (React web app), server (CherryPy APIs), and a database (SQLite).
• API-driven Design: Emphasize the RESTful API endpoints used by the frontend to perform operations like account management and bill processing.
• Containerization & CI/CD: Note the Dockerfile and GitHub workflows that streamline build, test, and deployment processes.
Relevant Technologies, Frameworks, and Libraries
• Frontend: React, Material-UI, npm.
• Backend: Python, CherryPy, SQLite.
• Additional Tools: Docker (for containerization), GitHub Actions (for CI/CD workflows).
Detail
• For clarity, you might also illustrate potential error-handling or state management aspects in the React app (e.g., UserContext usage).