Note that the **QA_RELEASE** branch is the merged branch of all the working components. The **master** contains only the common folder strcuture of the project.
...
...
@@ -101,12 +101,27 @@ Note that the **QA_RELEASE** branch is the merged branch of all the working comp
This folder structure adheres to the general project structure of a django web project. The following list describes the folders and files in use throughout the entire project.
* AttendanceApp - comprises the work of *Attendance Register* component.
* FirstApp - contains the implementations of *Monitoring Student Behavior* component.
* LectureSummarizingApp - constitutes the workings of the *Lecture Summarization* component.
* MonitorLecturerApp - comprises the implementations of *Monitoring Lecturer Performance* component.
* integrated_slpes - this contains the general settings and url configurations of the entire project.
* manage.py - this file is required to run the project (done by the comman *python manage.py runserver*)
* requirements.txt - contains the list of dependencies required to run the project.
***AttendanceApp** - comprises the work of *Attendance Register* component.
***FirstApp** - contains the implementations of *Monitoring Student Behavior* component.
***LectureSummarizingApp** - constitutes the workings of the *Lecture Summarization* component.
***MonitorLecturerApp** - comprises the implementations of *Monitoring Lecturer Performance* component.
***integrated_slpes** - this contains the general settings and url configurations of the entire project.
***manage.py** - this file is required to run the project (done by the comman *python manage.py runserver*)
***requirements.txt** - contains the list of dependencies required to run the project.
### Application strcuture
As mentioned above, the folders such as *AttendanceApp* and *FirstApp* are the applications reserved for each individual module. The following list will elaborate the common folders and files in an application folder.
***logic** - this folder contains the basic logic implementation for the application (implementations of deep learning models, processing etc....
***migrations** - comprises of the database migration files (*migration* in django means a way of propogating the changes made to your model, to the database schema). This is a folder generated by the django framework.
***templates** - this folder contains the html files (frontend) of the relevant application. However, the templates should be added inside another folder, with the same name as of your application.
***admin.py** - registering the models to the django admin site.
***api.py** - contains the RESTful API for the application.
***models.py** - all the database models are created within this file.
***serializers.py** - django provides a library to serialize the database models to facilitate the communication through REST API. The serialized class for each model is created here.
***tests.py** - testing implementations
***urls.py** - contains the specific url mappings for an application.
***views.py** - implements the frontend logic for each template file.
