Skip to content

FernandoSchett/github_repository_template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

30 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

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

๐ŸŸ  Application Title ๐ŸŸ 

Developed by ๐Ÿ’ป:

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:

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 ๐Ÿ› ๏ธ:

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 ๐Ÿ”—:

About

This is a template that i use to all my github projects.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors