- 📍 Overview
- 📂 Repository Structure
- 📂 Folder Descriptions
- 📝 Docker-Compose
- 📝 Code Source
- 🚀 Getting Started
For this mini-project, we provide you with the source code of a distributed application that allows an audience to vote between two options.
It's an application that has two web interfaces :
- The first one allows users to vote for one of the two options.
- The second interface allows users to view the voting results in real-time.
The project is comprised of three distinct modules:
Voting: Implemented as a Python web application, this module enables users to cast their votes for one of two available options.Worker: Developed in .NET, this service retrieves votes from a Redis instance and persistently stores them in a PostgreSQL database.Result: A Node.js web application that provides real-time visualization of voting results.
In addition to these primary modules, the application relies on two critical components:
PostgreSQL: This database stores the votes recorded by the Worker service.Redis: An instance of Redis is employed to facilitate the seamless and secure transmission of votes between different components of the application.
This application was launched with several bash scripts. To make it cleaner and simpler to run, we decided to use Docker.
└── docker-voting-app/
│
├── compose.yaml
│
├── result/
│ ├── Dockerfile
│ ├── server.js
│ ├── package.json
│ ├── package-lock.json
│ └── views/
│ ├── index.html
│ ├── app.js
│ ├── angular.min.js
│ ├── socket.io.js
│ └── stylesheets/
│ └── style.css
├── vote/
│ ├── Dockerfile
│ ├── app.py
│ ├── gunicorn_config.py
│ ├── requirements.txt
│ └── templates/
│ └── index.html
└── worker/
├── Dockerfile
├── Program.cs
└── Worker.csproj
The vote folder
This folder contains the voting page in Python.
It performs a POST request to the redis database for each vote.
The result folder
This folder contains the results page in javascript.
It retrieves votes in real time.
The worker folder
This folder links the redis database to postgres in the C# language.
It retrieves votes from the redis database and inserts them into postgres.
We used volumes of type "volume" to be able to store database information. We chose this type because we don't need to directly interact with or visualize the data.
We have updated the configurations in the files '/vote/app.py', '/worker/Progam.cs', and '/result/server.js' by replacing all occurrences of 'localhost' with either 'redis' or 'postgres,' depending on the specific requirements. This change was necessary because within a Docker container, 'localhost' points to the container itself, rather than the host machine.
Install Docker
On Windows : Download DockerDesktop
On Macbook : Download DockerDesktop
On Debian :
sudo apt-get update
sudo apt-get install ca-certificates curl gnupg
curl -fsSL https://download.docker.com/linux/debian/gpg | sudo apt-key add -
sudo apt-get update
sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
You can verify that the installation is successful by running hello-world image :
sudo docker run hello-world
Configure the .env file
Change the name of file to .env and define connection parameters to the postgres database.
git clone https://github.com/DoryanPl/docker-voting-app.git
cd docker-voting-app
docker compose up --build --force-recreate