Commit 9df744c9 authored by I.K Seneviratne's avatar I.K Seneviratne

Update README.md

parent 0d7b43ba
...@@ -113,15 +113,21 @@ This folder structure adheres to the general project structure of a django web p ...@@ -113,15 +113,21 @@ This folder structure adheres to the general project structure of a django web p
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. 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.... * **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. * **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. * **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. * **admin.py** - registering the models to the django admin site.
* **api.py** - contains the RESTful API for the application. * **api.py** - contains the RESTful API for the application.
* **models.py** - all the database models are created within this file. * **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. * **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 * **tests.py** - test case implementations
* **urls.py** - contains the specific url mappings for an application. * **urls.py** - contains the specific url mappings for an application.
* **views.py** - implements the frontend logic for each template file. * **views.py** - implements the frontend logic for each template file.
## Installation
To run this project, you will need to follow the given steps.
1. clone the repository to a desired location in your machine.
2. to download the classifiers, visit [here](https://www.google.com)
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment