[![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![MIT License][license-shield]][license-url]

[TITLE]

Explore the docs »

Report Bug · Request Feature

[TITLE]

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

You have python 3 installed.

Download and run

To download source code from git hub we can oen a terminal.

Winodws

New-Item -Path ($(Get-Location  | Select-Object -ExpandProperty Path) -Name "[FOLDER]" -ItemType "directory"
Invoke-WebRequest https://github.com/[GITHUB REPO]/archive/refs/heads/main.zip -OutFile [FOLDER].zip
Expand-Archive -Path Draftv2.zip -DestinationPath .\[FOLDER]
Get-Item "*[FOLDER]-*" | Rename-Item -NewName "[FOLDER]"
Set-Location .\[FOLDER]\srv\[FOLDER]

Linux

mkdir [FOLDER]
curl -L https://api.github.com/repos/[GITHUB REPO]/tarball | tar -xz --strip-components=3 -C [FOLDER]

For run the application go to the folder [FOLDER] and run.

cd [FOLDER]
python3 main.py

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

Fork the Project

1. Fork the Project
2. Create your Feature Branch
3. Commit your Changes
4. Push to the Branch
5. Open a Pull Request

Example

git checkout -b feature
git commit -m 'Add my feature enhance to project'
git push origin feature

[contributors-shield]: https://img.shields.io/github/contributors/[GITHUB REPO]?style=for-the-badge [contributors-url]: https://github.com/[GITHUB REPO]/graphs/contributors

[forks-shield]: https://img.shields.io/github/forks/[GITHUB REPO]?style=for-the-badge [forks-url]: https://github.com/[GITHUB REPO]/network/members

[stars-shield]: https://img.shields.io/github/stars/[GITHUB REPO]?style=for-the-badge [stars-url]: https://github.com/[GITHUB REPO]/stargazers

[issues-shield]: https://img.shields.io/github/issues/[GITHUB REPO]?style=for-the-badge [issues-url]: https://github.com/[GITHUB REPO]/issues

[license-shield]: https://img.shields.io/github/license/[GITHUB REPO]?style=for-the-badge [license-url]: https://github.com/[GITHUB REPO]/blob/master/LICENSE