{"id":16643645,"url":"https://github.com/josee9988/project-template","last_synced_at":"2025-04-04T09:09:59.235Z","repository":{"id":40643048,"uuid":"293084428","full_name":"Josee9988/project-template","owner":"Josee9988","description":"An awesome 𝗚𝗶𝘁𝗵𝘂𝗯 𝗧𝗲𝗺𝗽𝗹𝗮𝘁𝗲 for any project!🚀 Quickstart your projects and get control over your community.🔥 It includes 𝐢𝐬𝐬𝐮𝐞 𝐭𝐞𝐦𝐩𝐥𝐚𝐭𝐞𝐬, 𝐥𝐚𝐛𝐞𝐥𝐬, 𝐩𝐞𝐫𝐬𝐨𝐧𝐚𝐥𝐢𝐳𝐞𝐝 𝐫𝐞𝐚𝐝𝐦𝐞, 𝐆𝐢𝐭𝐡𝐮𝐛 𝐛𝐨𝐭𝐬, and much more!! 🤩","archived":false,"fork":false,"pushed_at":"2023-02-07T18:01:20.000Z","size":163,"stargazers_count":820,"open_issues_count":4,"forks_count":141,"subscribers_count":28,"default_branch":"master","last_synced_at":"2024-10-13T08:09:11.422Z","etag":null,"topics":["changelog-generator","community","community-management","contributing","docs","documentation","github-config","github-template","github-templates","issue-management","issue-template","issue-templates","issues","project-management","pull-request-template","readme-template","template","template-project","template-repository","templates"],"latest_commit_sha":null,"homepage":"https://github.com/Josee9988/project-template/generate","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Josee9988.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":".github/SECURITY.md","support":".github/SUPPORT.md","governance":null,"roadmap":null,"authors":null},"funding":{"github":"Josee9988","custom":["https://www.paypal.me/josee9988"]}},"created_at":"2020-09-05T13:46:30.000Z","updated_at":"2024-10-13T00:15:04.000Z","dependencies_parsed_at":"2024-01-13T19:42:35.579Z","dependency_job_id":"6aea257c-4c96-458a-ba5e-a35b1153c9aa","html_url":"https://github.com/Josee9988/project-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Josee9988%2Fproject-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Josee9988%2Fproject-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Josee9988%2Fproject-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Josee9988%2Fproject-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Josee9988","download_url":"https://codeload.github.com/Josee9988/project-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247149505,"owners_count":20891954,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["changelog-generator","community","community-management","contributing","docs","documentation","github-config","github-template","github-templates","issue-management","issue-template","issue-templates","issues","project-management","pull-request-template","readme-template","template","template-project","template-repository","templates"],"created_at":"2024-10-12T08:09:12.773Z","updated_at":"2025-04-04T09:09:59.216Z","avatar_url":"https://github.com/Josee9988.png","language":"Shell","funding_links":["https://github.com/sponsors/Josee9988","https://www.paypal.me/josee9988"],"categories":[],"sub_categories":[],"readme":"\u003c!-- markdownlint-disable MD032 MD033--\u003e\n# 🔥 **Josee9988's GitHub Project Template**\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/Josee9988/project-template/generate\"\u003e\n    \u003cimg width=\"100%\" src=\"https://i.imgur.com/SVvgxJF.png\" alt=\"@Josee9988/project-template's\"\u003e\n  \u003c/a\u003e\n  \u003cbr\u003e\n  \u003ca href=\"https://github.com/Josee9988/project-template/issues\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/issues/Josee9988/project-template?color=0088ff\u0026style=for-the-badge\u0026logo=github\" alt=\"@Josee9988/project-template's issues\"/\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/josee9988/project-template/pulls\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/issues-pr/Josee9988/project-template?color=0088ff\u0026style=for-the-badge\u0026logo=github\" alt=\"@Josee9988/project-template's pull requests\"/\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/Josee9988/project-template/generate\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/use%20this-template-blue?logo=github-sponsors\u0026style=for-the-badge\u0026color=green\" alt=\"@Josee9988/project-template link to create a new repository from the template\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/Josee9988/project-template/actions/workflows/shelltest.yml\"\u003e\n    \u003cimg src=\"https://github.com/Josee9988/project-template/actions/workflows/shelltest.yml/badge.svg\" alt=\"@Josee9988/project-template's tests\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n---\n\n## 🤔 **What is this template all about?**\n\n* This template can be used as a base layer for any of your future repositories/projects.\n* Make your project easy to maintain with **8 issue templates**.\n* Quick start your documentation with personalized **README badges** and an extraordinary README structure.\n* Manage your issues with **20 issue labels** created just for you!\n* Make your _community healthier_ with all the guides like code of conduct, contributing, support, security...\n* Learn more with the [official GitHub guide on creating repositories from a template](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template).\n* To start using it; \"**[click use this template](https://github.com/Josee9988/project-template/generate)**\" and create your new repository,\n* All the basic setup is made through an easy script that will auto-detect all your data to make it lightning fast! 🗲🗲 Clone your new repository and execute the `SETUP_TEMPLATE.sh` shell script to personalize the files with your private details. Check how to run it [here](https://asciinema.org/a/425259).\n* All the markdown follows [\"MarkdownLint\" rules](https://github.com/DavidAnson/markdownlint).\n\n---\n\n## ⚡ **Installation**\n\n1. To create a new repository from this template, **[generate your new repository from this template](https://github.com/Josee9988/project-template/generate)**;\nfor more information or guidance, follow the [GitHub guide](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template).\n2. Install the [🤖 used GitHub bots](https://github.com/Josee9988/project-template#-used-github-bots) (recommended)\n3. Clone your new repository **[generated from this template](https://github.com/Josee9988/project-template/generate)** and `cd` into it.\n4. **Execute** the `SETUP_TEMPLATE.sh` shell script to **customize** the files with your data.\n\n    ```bash\n    bash SETUP_TEMPLATE.sh\n    ```\n\n    Or\n\n    ```bash\n    ./SETUP_TEMPLATE.sh\n    ```\n\n    Additionally, watch *[this video](https://asciinema.org/a/425259)* to see **how to execute the script** or use *`bash SETUP_TEMPLATE.sh --help`* to obtain some extra information.\n\n    If the automatic detection of the username, project name or email is NOT correct, please post an issue, and you can **manually correct** them using the optional arguments like: *`bash SETUP_TEMPLATE.sh --username=whatever --projectName=whatever --email=whatever --projectType=whatever`*\n\n5. **Review** every single file and **customize** it as you like.\n6. Build your project. 🚀\n\n⚠️ _Customize every file to fit your requirements_ ⚠️\n\n---\n\n## 📚 **What does it include?**\n\n1. A **`SETUP_TEMPLATE.sh`** script that **MUST be executed right when you clone your repository**.\nThe script will customize all the data with yours in all the files.\n\n   1. A README template file with a default template to start documenting your project. (it includes personalized badges and text with your project details)\n   2. A CHANGELOG template file based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).\n   3. An [issue_label_bot.yaml](/.github/issue_label_bot.yaml) file to use the issue adder GitHub bot. [Activate it or check its documentation](https://github.com/marketplace/issue-label-bot).\n   4. A [config.yml](/.github/config.yml) file to modify multiple bot's behaviours.\n   5. A [settings.yml](/.github/settings.yml) file to use the popular settings GitHub bot. [Activate it or check its documentation](https://probot.github.io/apps/settings/).\n   6. A [CONTRIBUTING](/.github/CONTRIBUTING.md) explaining how to contribute to the project. [Learn more with the GitHub guide](https://docs.github.com/en/github/building-a-strong-community/setting-guidelines-for-repository-contributors).\n   7. A [SUPPORT](/.github/SUPPORT.md) explaining how to support the project. [Learn more with the GitHub guide](https://docs.github.com/en/github/building-a-strong-community/adding-support-resources-to-your-project).\n   8. A [SECURITY](/.github/SECURITY.md) with a guide on how to post a security issue. [Learn more with the GitHub guide](https://docs.github.com/en/code-security/getting-started/adding-a-security-policy-to-your-repository).\n   9. A [CODEOWNERS](/.github/CODEOWNERS) with the new user as the principal owner. [Learn more with the GitHub guide](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners).\n   10. A [CODE_OF_CONDUCT](/.github/CODE_OF_CONDUCT.md) with a basic code of conduct. [Learn more with the GitHub guide](https://docs.github.com/en/github/building-a-strong-community/adding-a-code-of-conduct-to-your-project).\n   11. A [PULL_REQUEST_TEMPLATE](/.github/pull_request_template.md) with a template for your pull request that closes issues with keywords. [Learn more with the GitHub guide](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository).\n   12. Multiple [issues templates](/.github/ISSUE_TEMPLATE). [Learn more with the GitHub guide](https://docs.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository).\n         1. A [config.yml](/.github/ISSUE_TEMPLATE/config.yml) with the config and information about the issue templates.\n         2. A [Blank issue template](/.github/ISSUE_TEMPLATE) with the super basic stuff, all the issues should contain.\n         3. A [Bug issue template](/.github/ISSUE_TEMPLATE/1-bug-report.md).\n         4. A [Failing test issue template](/.github/ISSUE_TEMPLATE/2-failing-test.md).\n         5. A [Documentation issue template](/.github/ISSUE_TEMPLATE/3-docs-bug.md).\n         6. A [Feature request issue template](/.github/ISSUE_TEMPLATE/4-feature-request.md).\n         7. An [Enhancement request issue template](/.github/ISSUE_TEMPLATE/5-enhancement-request.md).\n         8. A [Security report issue template](/.github/ISSUE_TEMPLATE/6-security-report.md).\n         9. A [Question or support issue template](/.github/ISSUE_TEMPLATE/7-question-support.md).\n\n---\n\n### 🌲 **Project tree**\n\nFiles that will get removed after the execution of `SETUP_TEMPLATE.sh` are not shown! 🙈\n\n```text\n.\n├── CHANGELOG.md\n├── .github\n│   ├── CODE_OF_CONDUCT.md\n│   ├── CODEOWNERS\n│   ├── config.yml\n│   ├── CONTRIBUTING.md\n│   ├── FUNDING.yml\n│   ├── issue_label_bot.yaml\n│   ├── ISSUE_TEMPLATE\n│   │   ├── 1-bug-report.md\n│   │   ├── 2-failing-test.md\n│   │   ├── 3-docs-bug.md\n│   │   ├── 4-feature-request.md\n│   │   ├── 5-enhancement-request.md\n│   │   ├── 6-security-report.md\n│   │   ├── 7-question-support.md\n│   │   └── config.yml\n│   ├── ISSUE_TEMPLATE.md\n│   ├── pull_request_template.md\n│   ├── SECURITY.md\n│   ├── settings.yml\n│   └── SUPPORT.md\n├── .gitignore\n└── README.md\n\n2 directories, 22 files\n```\n\n---\n\n## 📝 **Additional notes**\n\n* After **[generating your new repo with this template](https://github.com/Josee9988/project-template/generate)**, make sure to, right after you clone it, run the script `SETUP_TEMPLATE.sh`.\n\n* Then, after 'cloning' the repository you will be presented with all the files modified with your project details and information. It is essential to **manually review every file** to check if it fits your requirements and performs any necessary changes to customize the project as you want.\n\n* If you are using **Windows** and you don't know how to execute the `SETUP_TEMPLATE.sh` script:\n  1. Install **[git for Windows](https://git-scm.com/download/win)**.\n  2. Right-click on the git repository folder and click \"*git bash here*\".\n  3. Then just perform *`bash SETUP_TEMPLATE.sh`* **or** *`chmod u+x SETUP_TEMPLATE.sh \u0026\u0026 ./SETUP_TEMPLATE.sh`*.\n\n### 🤖 **Used GitHub bots**\n\nThese are recommended bots that are prepared and configured for this template. If you install them, your coding experience will probably be much better.\nWe sincerely recommend at least installing the [issue label bot](https://github.com/marketplace/issue-label-bot) as this bot is the one that adds all the labels used in the issue templates.\n\n1. The `issue_label_bot.yaml` file depends on the **[issue label bot](https://github.com/marketplace/issue-label-bot)** (✓ highly recommended).\n2. The `settings.yml` file depends on the **[settings label bot](https://probot.github.io/apps/settings/)** (optional).\n3. The `config.yml` file depends on the bot **[welcome bot](https://probot.github.io/apps/welcome/)** and **[to-do bot](https://probot.github.io/apps/todo/)** (optional).\n\n---\n\n## 📸 **Screenshots**\n\nA couple of screenshots to delight you before you use this template.\n\n### 🔺 All the issue templates\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"70%\" height=\"70%\" src=\"https://i.imgur.com/SDJixBz.png\" alt=\"All the issue templates.\"\u003e\n\u003c/p\u003e\n\n### 🔻 An issue template opened\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"70%\" height=\"70%\" src=\"https://i.imgur.com/r5AiLWu.png\" alt=\"Bug issue template opened.\"\u003e\n\u003c/p\u003e\n\n### 📘 The README template\n\nBadges and texts will be replaced with your project details!\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"70%\" height=\"70%\" src=\"https://i.imgur.com/dKKh53K.png\" alt=\"README.md template.\"\u003e\n\n  Or watch [this video](https://gifs.com/gif/josee9988-s-readme-md-MwO5E3) to see the whole README template.\n\u003c/p\u003e\n\n### 🔖 The labels for your issues\n\nIf the bot [probot-settings](https://probot.github.io/apps/settings/) is not installed you will not have these beautiful labels! (there are more issue labels than in the image!)\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"70%\" height=\"70%\" src=\"https://i.imgur.com/dS91k6R.png\" alt=\"LABELS\"\u003e\n\u003c/p\u003e\n\n### 📝 The CHANGELOG template\n\n(project name and project type will be replaced with yours)\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"70%\" height=\"70%\" src=\"https://i.imgur.com/ScWgQKI.png\" alt=\"CHANGELOG.md template.\"\u003e\n\u003c/p\u003e\n\n### 🛡️ Security policy\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"70%\" height=\"70%\" src=\"https://i.imgur.com/ArwDQTi.png\" alt=\"Security issue.\"\u003e\n\u003c/p\u003e\n\n### 💼 Community profile at 100%\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"70%\" height=\"70%\" src=\"https://i.imgur.com/kRt3lPs.png\" alt=\"Community profile.\"\u003e\n\u003c/p\u003e\n\n---\n\n## 🕵️ **Extra recommendations**\n\nFor the proper maintenance of the CHANGELOG.md, we recommend this [VSCode extension](https://github.com/Josee9988/Changelog-and-Markdown-snippets)\nand the read and understanding of the [keep a changelog guide](https://keepachangelog.com/en/1.0.0/).\nPlease read and comment about it in this [dev.to post](https://dev.to/josee9988/the-ultimate-github-project-template-1264).\nWe also recommend installing all the [used bots](https://github.com/Josee9988/project-template#-used-github-bots).\n\n## 💉 **Project tests**\n\nIf you want to improve the development of this project, you must, after changing or improving whatever, run the project's tests to prove that they are working.\n\nTo do so:\n\n```bash\nbash tests/TESTS_RUNNER.sh\n```\n\n---\n\n## 🍰 **Supporters and donators**\n\n\u003ca href=\"https://github.com/Josee9988/project-template/generate\"\u003e\n  \u003cimg alt=\"@Josee9988/project-template's brand logo without text\" align=\"right\" src=\"https://i.imgur.com/3qK1sie.png\" width=\"18%\" /\u003e\n\u003c/a\u003e\n\nWe are currently looking for new donators to help and maintain this project! ❤️\n\nBy donating, you will help the development of this project, and *you will be featured in this project's README.md*, so everyone can see your kindness and visit your content ⭐.\n\n\u003ca href=\"https://github.com/sponsors/Josee9988\"\u003e\n  \u003cimg alt=\"project logo\" src=\"https://img.shields.io/badge/Sponsor-Josee9988/project template-blue?logo=github-sponsors\u0026style=for-the-badge\u0026color=red\"\u003e\n\u003c/a\u003e\n\n---\n\n## 🎉 Was the template helpful? Please help us raise these numbers up\n\n[![GitHub's followers](https://img.shields.io/github/followers/Josee9988.svg?style=social)](https://github.com/Josee9988)\n[![GitHub stars](https://img.shields.io/github/stars/Josee9988/project-template.svg?style=social)](https://github.com/Josee9988/project-template/stargazers)\n[![GitHub watchers](https://img.shields.io/github/watchers/Josee9988/project-template.svg?style=social)](https://github.com/Josee9988/project-template/watchers)\n[![GitHub forks](https://img.shields.io/github/forks/Josee9988/project-template.svg?style=social)](https://github.com/Josee9988/project-template/network/members)\n\nEnjoy! 😃\n\n\u003e ⚠️ Remember that this template should be reviewed and modified to fit your requirements.\n\u003e The script **SETUP_TEMPLATE.sh** should be executed right when you clone your new repository generated from [here](https://github.com/Josee9988/project-template/generate).\n\u003e There will be files that will need *manual revision* ⚠️\n\n_Made with a lot of ❤️❤️ by **[@Josee9988](https://github.com/Josee9988)**_\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjosee9988%2Fproject-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjosee9988%2Fproject-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjosee9988%2Fproject-template/lists"}