templinktool 1.0.0
Creates a temporary server to share files
License: MIT

<p align="center">
  <img src="https://raw.githubusercontent.com/PKief/vscode-material-icon-theme/ec559a9f6bfd399b82bb44393651661b08aaf7ba/icons/folder-markdown-open.svg" width="100" alt="project-logo">
</p>
<p align="center">
    <h1 align="center">TEMPLINKMAKER</h1>
</p>
<p align="center">
    <em><code>► INSERT-TEXT-HERE</code></em>
</p>
<p align="center">
	<img src="https://img.shields.io/github/license/sdidd/templinkMaker.git?style=default&logo=opensourceinitiative&logoColor=white&color=0080ff" alt="license">
	<img src="https://img.shields.io/github/last-commit/sdidd/templinkMaker.git?style=default&logo=git&logoColor=white&color=0080ff" alt="last-commit">
	<img src="https://img.shields.io/github/languages/top/sdidd/templinkMaker.git?style=default&color=0080ff" alt="repo-top-language">
	<img src="https://img.shields.io/github/languages/count/sdidd/templinkMaker.git?style=default&color=0080ff" alt="repo-language-count">
<p>
<p align="center">
	<!-- default option, no dependency badges. -->
</p>

<br><!-- TABLE OF CONTENTS -->
<details>
  <summary>Table of Contents</summary><br>

- [ Overview](#-overview)
- [ Features](#-features)
- [ Repository Structure](#-repository-structure)
- [ Modules](#-modules)
- [ Getting Started](#-getting-started)
  - [ Installation](#-installation)
  - [ Usage](#-usage)
  - [ Tests](#-tests)
- [ Project Roadmap](#-project-roadmap)
- [ Contributing](#-contributing)
- [ License](#-license)
- [ Acknowledgments](#-acknowledgments)
</details>
<hr>

##  Overview

<code>► INSERT-TEXT-HERE</code>

---

##  Features

<code>► INSERT-TEXT-HERE</code>

---

##  Repository Structure

```sh
└── templinkMaker/
    ├── LICENSE
    ├── cli_modules
    │   ├── __init__.py
    │   ├── app.py
    │   ├── cli.py
    │   └── utils.py
    ├── main.py
    ├── readme-ai.md
    ├── requirnments.txt
    ├── setup.py
    └── templates
        └── index.html
```

---

##  Modules

<details closed><summary>.</summary>

| File                                                                                        | Summary                         |
| ---                                                                                         | ---                             |
| [setup.py](https://github.com/sdidd/templinkMaker.git/blob/master/setup.py)                 | <code>► INSERT-TEXT-HERE</code> |
| [requirnments.txt](https://github.com/sdidd/templinkMaker.git/blob/master/requirnments.txt) | <code>► INSERT-TEXT-HERE</code> |
| [main.py](https://github.com/sdidd/templinkMaker.git/blob/master/main.py)                   | <code>► INSERT-TEXT-HERE</code> |

</details>

<details closed><summary>templates</summary>

| File                                                                                      | Summary                         |
| ---                                                                                       | ---                             |
| [index.html](https://github.com/sdidd/templinkMaker.git/blob/master/templates/index.html) | <code>► INSERT-TEXT-HERE</code> |

</details>

<details closed><summary>cli_modules</summary>

| File                                                                                    | Summary                         |
| ---                                                                                     | ---                             |
| [utils.py](https://github.com/sdidd/templinkMaker.git/blob/master/cli_modules/utils.py) | <code>► INSERT-TEXT-HERE</code> |
| [cli.py](https://github.com/sdidd/templinkMaker.git/blob/master/cli_modules/cli.py)     | <code>► INSERT-TEXT-HERE</code> |
| [app.py](https://github.com/sdidd/templinkMaker.git/blob/master/cli_modules/app.py)     | <code>► INSERT-TEXT-HERE</code> |

</details>

---

##  Getting Started

**System Requirements:**

* **Python**: `version x.y.z`

###  Installation

<h4>From <code>source</code></h4>

> 1. Clone the templinkMaker repository:
>
> ```console
> $ git clone https://github.com/sdidd/templinkMaker.git
> ```
>
> 2. Change to the project directory:
> ```console
> $ cd templinkMaker
> ```
>
> 3. Install the dependencies:
> ```console
> $ pip install -r requirements.txt
> ```

###  Usage

<h4>From <code>source</code></h4>

> Run templinkMaker using the command below:
> ```console
> $ python main.py
> ```

###  Tests

> Run the test suite using the command below:
> ```console
> $ pytest
> ```

---

##  Project Roadmap

- [X] `► INSERT-TASK-1`
- [ ] `► INSERT-TASK-2`
- [ ] `► ...`

---

##  Contributing

Contributions are welcome! Here are several ways you can contribute:

- **[Report Issues](https://github.com/sdidd/templinkMaker.git/issues)**: Submit bugs found or log feature requests for the `templinkMaker` project.
- **[Submit Pull Requests](https://github.com/sdidd/templinkMaker.git/blob/main/CONTRIBUTING.md)**: Review open PRs, and submit your own PRs.
- **[Join the Discussions](https://github.com/sdidd/templinkMaker.git/discussions)**: Share your insights, provide feedback, or ask questions.

<details closed>
<summary>Contributing Guidelines</summary>

1. **Fork the Repository**: Start by forking the project repository to your github account.
2. **Clone Locally**: Clone the forked repository to your local machine using a git client.
   ```sh
   git clone https://github.com/sdidd/templinkMaker.git
   ```
3. **Create a New Branch**: Always work on a new branch, giving it a descriptive name.
   ```sh
   git checkout -b new-feature-x
   ```
4. **Make Your Changes**: Develop and test your changes locally.
5. **Commit Your Changes**: Commit with a clear message describing your updates.
   ```sh
   git commit -m 'Implemented new feature x.'
   ```
6. **Push to github**: Push the changes to your forked repository.
   ```sh
   git push origin new-feature-x
   ```
7. **Submit a Pull Request**: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. **Review**: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!
</details>

<details closed>
<summary>Contributor Graph</summary>
<br>
<p align="center">
   <a href="https://github.com{/sdidd/templinkMaker.git/}graphs/contributors">
      <img src="https://contrib.rocks/image?repo=sdidd/templinkMaker.git">
   </a>
</p>
</details>

---

##  License

This project is protected under the [SELECT-A-LICENSE](https://choosealicense.com/licenses) License. For more details, refer to the [LICENSE](https://choosealicense.com/licenses/) file.

---

##  Acknowledgments

- List any resources, contributors, inspiration, etc. here.

[**Return**](#-overview)

---