Add README.md

This commit is contained in:
Dario Duchateau-weinberger 2023-09-27 18:43:11 +02:00
parent d8fc223e39
commit a1c6329acd

65
README.md Normal file
View File

@ -0,0 +1,65 @@
<div align="center">
<p>
<img src="img/logo.svg"
height="130">
</p>
<p align="center">
<a href="https://blog-raph.dariow.fr" alt="Portfolio">
<img alt="Website" src="https://img.shields.io/website?up_message=Raphael%20PAYET&url=https%3A%2F%2Fblog-raph.dariow.fr&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAAsQAAALEBxi1JjQAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAJjSURBVEiJtdbLb01RFAbwX28inWhSb0nrVUpHUiYkImZE0AlT8RirMJcwk0iMatT6AzojHp0WiYiJeA1QrXhdUgyUeKSqBnud3H2PtirhS072veusvR7fWWvt3WBmLEcXdqENLSF/hWe4ikt48Qc7v6EV5/EDk/G8xvN4XmfycfTFnlmhC2MYxUlUcR+LcDmexXgY706F7hj2lI1VSv+7cQHX0Y4JzMc+vMv0RrEXCyLLdtzAxbAxbeQT6A/HjWGoJ9MpMijQEzqNsac/bPyWSWuk+E3i9ZbE6090zOCgI3T6Ys9k2BhTKwikD/pG4vYgBiOSSXzFEK5JnFfj91C8mwzdQRwIG2/DqQapFEdwDOcyp89xB7exBguxJd7dxPtwshkbsSLbexRnpdLWjS+YmynMi8j2q0eZIqHzE82ZrCmyO1LBTqlqPmcKq2N97M94LDHRlsk+SVW1syKV2N3SpoWxjs7CQVG+i0rye1jTEN7eSJwXWIz1Umbjmbwz1jygOdgmNWMe0AosrUhc/1c8wemSbEc4XlWST/WR20J3e0l+Bo8qeKqWeoEPsZZ5nQqFzvuSvBPDFQxIHOZlOhzrulk4WCtlMJLJmrAVA0WjDeO46RutXRpseaN9kBptEzZgZba3rtFIbV2MisPSKPjbUXENh9RGRW+e5r8edh+Vhh1pxP6rcb27bLxAdyhckWbLiYio+Ni5gw58D51m6XyeMMOBk2cyJo2AUxLnDyRuCwdL1B+Z7yRapo28jBaJ13G1w72qduhX1R/6vabgnDQFZ8Iy9deW4ubwSqr74trycjoDvwCYk8zNCgNVYwAAAABJRU5ErkJggg==&label=&labelColor=white&color=blue"></a>
<a href="https://blog.dariow.fr" alt="Portfolio">
<img alt="Website" src="https://img.shields.io/website?up_message=Dario%20WEINBERGER&url=https%3A%2F%2Fblog.dariow.fr&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAAsQAAALEBxi1JjQAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAJjSURBVEiJtdbLb01RFAbwX28inWhSb0nrVUpHUiYkImZE0AlT8RirMJcwk0iMatT6AzojHp0WiYiJeA1QrXhdUgyUeKSqBnud3H2PtirhS072veusvR7fWWvt3WBmLEcXdqENLSF/hWe4ikt48Qc7v6EV5/EDk/G8xvN4XmfycfTFnlmhC2MYxUlUcR+LcDmexXgY706F7hj2lI1VSv+7cQHX0Y4JzMc+vMv0RrEXCyLLdtzAxbAxbeQT6A/HjWGoJ9MpMijQEzqNsac/bPyWSWuk+E3i9ZbE6090zOCgI3T6Ys9k2BhTKwikD/pG4vYgBiOSSXzFEK5JnFfj91C8mwzdQRwIG2/DqQapFEdwDOcyp89xB7exBguxJd7dxPtwshkbsSLbexRnpdLWjS+YmynMi8j2q0eZIqHzE82ZrCmyO1LBTqlqPmcKq2N97M94LDHRlsk+SVW1syKV2N3SpoWxjs7CQVG+i0rye1jTEN7eSJwXWIz1Umbjmbwz1jygOdgmNWMe0AosrUhc/1c8wemSbEc4XlWST/WR20J3e0l+Bo8qeKqWeoEPsZZ5nQqFzvuSvBPDFQxIHOZlOhzrulk4WCtlMJLJmrAVA0WjDeO46RutXRpseaN9kBptEzZgZba3rtFIbV2MisPSKPjbUXENh9RGRW+e5r8edh+Vhh1pxP6rcb27bLxAdyhckWbLiYio+Ni5gw58D51m6XyeMMOBk2cyJo2AUxLnDyRuCwdL1B+Z7yRapo28jBaJ13G1w72qduhX1R/6vabgnDQFZ8Iy9deW4ubwSqr74trycjoDvwCYk8zNCgNVYwAAAABJRU5ErkJggg==&label=&labelColor=white&color=blue"></a>
</p>
</div>
<br>
Wikipedia article comparison tool. This tool allows you to compare the data contained in the infoboxes as well as statistics of 2 different wikipedia articles
[TOC]
## Demo
## Dependencies
We use docker containers, so it will be necessary to have Docker and Docker compose.
Installation Guides:
- <a href="https://docs.docker.com/"><img src="https://img.shields.io/badge/-docker-61DAFB?logo=docker&logoColor=white&style=plastic"></div>
- <a href="https://docs.docker.com/compose/install/"><img src="https://img.shields.io/badge/-docker%E2%81%83compose-61DAFB?style=plastic"></a>
## Install
Configure logins and passwords in the.env located in the root of the project (PLEASE USE STRONG PASSWORDS):
```yml
MYSQL_ROOT_PASSWORD=changeme
MYSQL_USER=radar
MYSQL_PASSWORD=changeme
```
Building images using docker-compose.yml:
```shell
docker-compose build
```
Launching containers using the docker-compose.yml file:
```shell
docker-compose up -d
```
The site is now available locally on https://localhost:8888
Or at the ip address of your machine [https://\<your-ip-adresse>:8888]()