This READ.md template was written based on this repository.

🟠 Application Title 🟠

Developed by 💻:

• <you_name>.

Special thanks to 🥰:

• <person_name>, Your experience and knowledge have been invaluable to our progress.

About 🤔:

Summary 📝:

Resourses 🧑‍🔬:

Results 📈:

Routes 🛣️:

Every Route from the API can be found in swagger.

Dependencies 🚚:

The project dependencies are described in ./dependencies/requirements. within the repository. In summary, heres what you're gonna need in order to run the project:

• dependencie <version>.

For installing dependencies more quickly, you can run the following command at terminal, inside the clonned repository:

sudo apt update && sudo apt install python3 python3-pip
pip3 install -r ./dependencies/requirements.txt

Make sure you have all Dependencies before running the project.

How to run it 🏃:

First, clone this repository. After that, simply execute the file_name file with the command:

sudo command_for_running_project

How to install 🔬:

Screens 🎬:

<app_name> screens were developed to turn out like figma screens:

Figure 1 - Screens from

UML‍ 💬:

Heres the UML that represents how the application works with their classes.

classDiagram

Loading

Figure 2 - UML.

Logic Model 🧮:

Here's the logic model that represents how the code works with their classes.

Figure 3 - Logic Model.

Database 🗃️:

Figure 4 - Relational Model Database.

Development Process ⚙️:

Developers used Trello to get things organized, each one using their own branch to code, using names to identify the commit type then merginng the features into develop branch. After testing, the group update the main branch. This application was developed in xx/xx/20xx until xx/xx/20xx.

Tools Used 🛠️:

• Tool.

For installing some tools more quickly, you can run the following command at terminal, inside the clonned repository:

sh ./dependencies/install_tools.sh

How to contribute 🫂:

Feel free to create a new branch, fork the project, create a new Issue or make a pull request contact one of us to develop at <app_name>.

Licence 📜:

Apache V2

References 📙:

[1] <last_author_name>, <first_author_name>. <work_title>. XX/XX/XX.

[2] <work_title>, <author_name>. Avaliable in: https://www.link.com. Access in em XX/XX/XX.

Important links 🔗: