Skip to content
Snippets Groups Projects
Normal view Permalink
overview.md 1.3 KiB
Newer Older
  • Learn to ignore specific revisions
    • Victor Löfgren's avatar
    Add documentation
    Victor Löfgren committed
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 
    # System overview

The system has a fairly simple design, as depicted in the image below.
The terms frontend and client as well as backend and server will be used interchangeably.

![Systemöversikt](../_static/system_overview.svg)

First we have the main server which is written in Python using the micro-framework Flask.
Then have a fairly small Node server who's only function is to serve the React frontend pages.
Lastly we have the frontend which is written in TypeScript using React and Redux.

## Communication

The frontend communicates with the backend in two ways.
All of the following ways are authorized on the server to make sure that who ever tried to communicate has the correct access level.

### API

API calls are used for simple functions the client wants to perform, such as getting, editing and saving data.
These are sent from the client to the backend Node server who will proxy the request to the main Python server.
The request will then be handled there and the response will be sent back.
The Node server will then send them back to the client.

### Sockets

The client can also communicate directly with the server via sockets.
These are suited for fast real time communication.
Thus they are used during an active presentation to sync things between different views such as current slide and timer.