Skip to content

Architecture

Petri Riihikallio edited this page Aug 13, 2021 · 13 revisions

Glossary

There are a lot of potentially unfamiliar terminology used in this document so it might be helpful to briefly explain some of them.

Django: Django is a Python web application framework that uses traditional server-side scripting. The framework follows Model-view-controller (MVC) design pattern.

Django REST Framework: Django REST Framework is an Django extension with some additional functionality.

Docker: Docker is a tool for bundling applications into images that contains all the libraries and resources that the application needs including a preferred Linux distribution. Dockerfile contains the instructions on how to create an image. These images can be used to created instances called containers that can be started, stopped and removed.

Docker Compose: Docker Compose is a tool for making the management of multiple Docker containers easier. The configuration is stored in a docker-compose.yml file.

PostgreSQL: PostgreSQL is a relational database management system.

Environment

The full environment is set up using Docker Compose and consists of two Docker containers:

  • web contains Django web server (nicknamed WebMark2)
  • db contains PostgreSQL database

On the staging server there is also a third container running Lighttpd to serve static files.

Web server

The web server has been nicknamed WebMark2. Folder /webmark2 contains project settings and /qleader contains the actual application. WebMark2 uses Django REST framework.

Here is the uml of the WebMark2:

WebMark2_uml

(The instructions on how the image above was generated can be found here)

Database

The database uses PostgreSQL and the schema is shown in the following diagram. User table has been automatically created by Django and most of the fields are not used. The relevant fields are username and password.

Here is the WebMark2's database diagram.

WebMark's dbdiagram

(The instructions on how the image above was generated can be found here)

Repositories

Clone this wiki locally