This is a project on implementing a new web application that aims to enhance the learning experience in programming among college students. The program is trying to solve time-consuming in making problems in programming and the need for customized solutions. Partnering with course instructors, this app will be using OpenAI's API with professors wanting to create customized questions relevant to the university curriculum about programming. This interactive platform offers a lot of challenging problems with AI-driven guidance and solutions to bridge the gap from theory to practice. We would like to build an active culture for learning programming that would foster programming skills and further engage our college's programming community.
The system will have four main components:
- Instructor: This component is responsible for managing and creating educational content, such as courses, problem sets, and assignments.
- Student: This component represents the person who accesses the system to solve problems, submit their work, and receive feedback.
- Database: This component is responsible for storing and managing the system's data, including user information, course information, problem sets, and student progress. It ensures that the system's data is accurate, up-to-date, and easily accessible.
- Open AI: This component is focused on AI technology to enhance the system's functionality. The AI will mainly help instructors generate problems and automate the problem-writing process.
Each app in Django is designed to handle a specific piece of functionality, encapsulating related models, views, templates, and static files. This feature supports the single responsibility and the separation of concerns principles and helps us to maintain and test components independently, reducing the complexity of the code. In our application, the apps are divided as follows:
- Course App: Responsible for managing courses.
- Problem App: Responsible for managing problems.
- Dashboard App: Responsible for managing the dashboard and navbar.
- Editor App: Responsible for running codes and validating solutions.
- Users App: Responsible for managing users' authentication system.
- OpenAI API App: Responsible for integrating generative AI capabilities.
The choice of a robust architectural pattern is crucial for the success of any software project, Model-View-Template (MVT) architectural pattern is adopted in each app, with a specific focus on Python Django Web Framework. MVT provides a structured and modular approach to organizing code, separating concerns related to data models, user interfaces, and control flow. The MVC components in our system are organized as follows:
- Model (M): The data models represent the structure of programming problems, user information, and other relevant entities. These models are designed to encapsulate data and business logic, ensuring a clear and maintainable representation of our application's core entities.
- View (V): Handles the presentation logic. In Django, views process incoming HTTP requests, interact with the models to retrieve or manipulate data and return appropriate HTTP responses. The views are responsible for processing user input, interacting with the models, and rendering templates to generate the final output.
- Template (T): Defines how the data from the views should be presented. Django Templates are responsible for dynamically generating HTML based on the data provided by the views.
