README.md

main

---

Few lines describing the project.

Table of Contents

• About
• TODO-LIST
• CHANGELOG
• Getting Started
• Running the tests
• Usage
• Deployment
• Built Using
• Authors

About

Few lines about the purpose of the project

TODO-LIST

• 1st March : Retry build after reset monthly limit
• Create compilations in zip
  • Edit specs
  • rework updater.py to make it work with zip and --onefile exe
• Create a modular app system
  • PyQt5 app
• Create a login system that identify user and check if authorized
• Feed docstring

CHANGELOG

Unreleased

1.0.0 - 2023-02-20

Added

Changed

Deprecated

Removed

Fixed

Security

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them.

Give examples

Installing

A step by step series of examples that tell you how to get a development env running.

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo.

Running the tests

Explain how to run the automated tests for this system.

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Usage

Add notes about how to use the system.

Deployment

Add additional notes about how to deploy this on a live system.

Built Using

• MongoDB - Database
• Express - Server Framework
• VueJs - Web Framework
• NodeJs - Server Environment
• Python - Programming language
• PyQt - Qt application Framework

Authors

• @Emericdefay - Idea & Initial work