Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/MarketingPipeline/Awesome-Repo-Template

An awesome repo template packed with tons of tools & more to kick-start your next project / repo!
https://github.com/MarketingPipeline/Awesome-Repo-Template

List: Awesome-Repo-Template

awesome awesome-readme awesome-repo-template code-of-conduct-template github github-action github-actions github-buttons github-config github-readme github-repository github-template github-templates issue-template issue-templates readme readme-template repo-template repository-template template-repository

Last synced: 2 months ago
JSON representation

An awesome repo template packed with tons of tools & more to kick-start your next project / repo!

Host: GitHub
URL: https://github.com/MarketingPipeline/Awesome-Repo-Template
Owner: MarketingPipeline
License: mit
Created: 2022-06-24T17:16:46.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2023-03-03T14:13:14.000Z (almost 2 years ago)
Last Synced: 2024-05-20T01:06:43.254Z (8 months ago)
Topics: awesome, awesome-readme, awesome-repo-template, code-of-conduct-template, github, github-action, github-actions, github-buttons, github-config, github-readme, github-repository, github-template, github-templates, issue-template, issue-templates, readme, readme-template, repo-template, repository-template, template-repository
Language: HTML
Homepage:
Size: 424 KB
Stars: 142
Watchers: 6
Forks: 38
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md

Awesome Lists containing this project

project-awesome - MarketingPipeline/Awesome-Repo-Template - An awesome repo template packed with tons of tools & more to kick-start your next project / repo! (HTML)
jimsghstars - MarketingPipeline/Awesome-Repo-Template - An awesome repo template packed with tons of tools & more to kick-start your next project / repo! (HTML)

README

        # Awesome-Repo-Template [![Awesome](https://awesome.re/badge.svg)](https://github.com/MarketingPipeline/Awesome-Repo-Template/)







  A awesome repo template to kick-start your next project

  


   Show your support! 

  


   

    

  

  

    

  

   
  

## Features:

- A configurable workflow action to:  

  - update all links with your own with EASE!

  - update Code Of Conduct E-mail with your own!

  - update Security Policy E-mail with your own!

  - download files & folder from another GitHub Repo

  - compress / optimize all images in repo!

  - generate a Markdown styled [index file](index.html) with SEO details!

  - generate a table of contents in your README

  - generate a star-gazer metrics SVG image

- Time Saving Files:

  - [Pull request template](.github/pull_request_template.md)

  - Issue templates for [bug reports](.github/ISSUE_TEMPLATE/bug_report.yaml) and

    [feature requests](.github/ISSUE_TEMPLATE/feature_request.yaml)

  - [Contributor guidelines](.github/CONTRIBUTING.md)

  - [Code Owners](.github/CODEOWNERS)

  - [Code of Conduct](.github/CODE_OF_CONDUCT.md)

  - [Change-log](.github/CHANGE_LOG.md)

  - [To-Do list](.github/TO_DO.md)

  - [Security Policy](.github/SECURITY.md)

  - [README](README.md)

  - [License file](LICENSE) 

   - GitHub Bot Files

       -  [config.yml](/.github/config.yml) file to modify multiple bot's behaviours.

       -  [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).

       -  [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/).

## Example and Usage

	

 


How to use this template:

 
		

 

 To run any of these tasks you MUST be in the Actions section

 

 How to find the Action

 

 ![image](https://user-images.githubusercontent.com/86180097/177446180-b71e50d1-df9d-4ef8-8d78-91184702cff0.png) 

	


	 


	 

	

How to replace all links with your own:


	

	

Edit the [repo_config.json](.github/py_repo_tools/repo_config.json) file & set the value for "REPLACE_TEXT_WITH" - to your username & repo name like the following example 

       MyUserName/My-Repo-Name

And run the Repo Generator in Actions - set "Update all links" to checked

 
	 
	 
	 
	 
	 
	 
	 
	 
	


	 


	 

	

How to replace e-mail in Code of Conduct with your own:


	

	

Edit the [repo_config.json](.github/py_repo_tools/repo_config.json) file & set the value for "EMAIL" - to your e-mail address like the following example. 

       [email protected]

And run the Repo Generator in Actions- set "Update Code Of Conduct Info" to checked

 
	 
	 
	 
	 
	 
	 
	 
	 
	


	 


	 

	

How to replace e-mail in Security Policy with your own:


	

	

Edit the [repo_config.json](.github/py_repo_tools/repo_config.json) file & set the value for "EMAIL" - to your e-mail address like the following example. 

       [email protected]

And run the Repo Generator in Actions- set "Update Security Info" to checked

 
	 
	 
	 
	 
	 
	 
	 
	 
	


	 


	 

	

How to download  file(s) / folder(s) from another GitHub repo


	

	




 WARNING

files downloaded from a repo containing the same name in your current repo will be OVER-WRITTEN.


 
 
 
 

	

In the Repo Generator Actions- set "Download a file or folder from a GitHub Repo" to a GitHub file path or folder.

Example(s)

To download a single file:

     https://github.com/Repo-Owner-UserName/Repo-Name/blob/master/README.md

To download a specific folder:

     https://github.com/Repo-Owner-UserName/Repo-Name/blob/master/Folder-Name

     

 

To download all files in a repo folder:

     https://github.com/Repo-Owner-UserName/Repo-Name/blob/master/

     

     

Note: File's will be placed into main repo path. 

 
	 
	 
	 
	 
	 
	 
	 
	 
	


	 


	 

	

How to generate a index.html file


	

	

	

A index.html file will be produced from your README content.

SEO details such as Title, Description & OG images etc are auto-produced using your Repo details.

Note Your README content will be rendered in Github Flavored Markdown using our tool [Markdown-Tag: Add Markdown to any HTML using a  tag](https://github.com/MarketingPipeline/Markdown-Tag)

Go to the Repo Generator in Actions- set "Generate Index File" to checked

 
	 
	 
	 
	 
	 
	 
	 
	 
	


	 


	 

	

How to compress / optimize images in repo


	

	

Note: All images in repo will be compressed / optimized (SVG's are NOT supported)

Go to the Repo Generator in Actions- set "Compress / Optimize Images" to checked

 
	 
	 
	 
	 
	 
	 
	 
	 
	

 
		

 

	


	 


	 

	

How to generate Table Of Contents:


	

To generate tables of contents automatically use anywhere in your README.md file a comment like so

   

<!-- toc -->

<!-- tocstop -->

And when running the Repo Generator in Actions - set "Generate Table Of Contents" to checked

WARNING: Only 1 table of contents can be generated in a README - if you use more than one you WILL face problems. 

 
	 
	 
	 
	 
	 
	 
	 
	 
	

 
		

 

	


	 


	 

	

How to Generate a Metrics Image:


	

 

Create a Personal Access Token & create a repo secret called "METRICS_TOKEN" & when running the Repo Generator - set "Generate Metrics Image File" to checked 

You will have an image generated that looks like this!



It will be placed in the main repo under the filename stargazers-metrics.svg 

Note: if someone knows how to change this please make a pull request with the image placed to .github folder!

 
	 
	 
	 
	 
	 
	 
	 
	 
	


	 
	 
	 
	 
	 
	 
	 
	 
		

	


	 

	

Shield.io Buttons:




_Repo metadata_

	

[![Github license](https://img.shields.io/github/license/MarketingPipeline/Awesome-Repo-Template.svg "Github license")](https://github.com/MarketingPipeline/Awesome-Repo-Template/blob/master/LICENSE)

[![Open issues](https://img.shields.io/github/issues/MarketingPipeline/Awesome-Repo-Template.svg "Open issues")](https://github.com/MarketingPipeline/Awesome-Repo-Template/issues)

[![Closed issues](https://img.shields.io/github/issues-closed/MarketingPipeline/Awesome-Repo-Template.svg "Closed issues")](https://github.com/MarketingPipeline/Awesome-Repo-Template/issues?utf8=✓&q=is%3Aissue+is%3Aclosed)

[![Open Pull Requests](https://img.shields.io/github/issues-pr/MarketingPipeline/Awesome-Repo-Template.svg "Open Pull Requests")](https://github.com/MarketingPipeline/Awesome-Repo-Template/pulls)

[![Closed Pull Requests](https://img.shields.io/github/issues-pr-closed/MarketingPipeline/Awesome-Repo-Template.svg "Closed Pull Requests")](https://github.com/MarketingPipeline/Awesome-Repo-Template/pulls?utf8=✓&q=is%3Apr+is%3Aclosed)

[![Commit activity](https://img.shields.io/github/commit-activity/m/MarketingPipeline/Awesome-Repo-Template.svg "Commit activity")](https://github.com/MarketingPipeline/Awesome-Repo-Template/graphs/commit-activity)

[![GitHub contributors](https://img.shields.io/github/contributors/MarketingPipeline/Awesome-Repo-Template.svg "Github contributors")](https://github.com/MarketingPipeline/Awesome-Repo-Template/graphs/contributors)

[![Last commit](https://img.shields.io/github/last-commit/MarketingPipeline/Awesome-Repo-Template.svg "Last commit")](https://github.com/MarketingPipeline/Awesome-Repo-Template/commits/master)

[![GitHub tag](https://img.shields.io/github/tag/MarketingPipeline/Awesome-Repo-Template?include_prereleases=&sort=semver&color=blue)](https://github.com/MarketingPipeline/Awesome-Repo-Template/releases/)

_Social buttons_

[![MarketingPipeline - Awesome-Repo-Template](https://img.shields.io/static/v1?label=MarketingPipeline&message=Awesome-Repo-Template&color=blue&logo=github)](https://github.com/MarketingPipeline/Awesome-Repo-Template "Go to GitHub repo")

[![stars - Awesome-Repo-Template](https://img.shields.io/github/stars/MarketingPipeline/Awesome-Repo-Template?style=social)](https://github.com/MarketingPipeline/Awesome-Repo-Template)

[![forks - Awesome-Repo-Template](https://img.shields.io/github/forks/MarketingPipeline/Awesome-Repo-Template?style=social)](https://github.com/MarketingPipeline/Awesome-Repo-Template)

_Call-to-Action buttons_

[![Use this template](https://img.shields.io/badge/Generate-Use_this_template-2ea44f?style=for-the-badge)](https://github.com/MarketingPipeline/Awesome-Repo-Template/generate)

[![View site - GH Pages](https://img.shields.io/badge/View_site-GH_Pages-2ea44f?style=for-the-badge)](https://marketingpip.github.io/Awesome-Repo-Template/)

_Documentation button_

[![view - Documentation](https://img.shields.io/badge/view-Documentation-blue?style=for-the-badge)](/README.MD "Go to project documentation")

_Custom button_

	


	 
	 
	 
	 
	 
	 
	 
	 
	

	


	 

	 

Auto Generated Table Of Contents  Demo:




- [Features:](#features)

- [Example and Usage](#example-and-usage)

- [Contributing  ![GitHub](https://img.shields.io/github/contributors/MarketingPipeline/Awesome-Repo-Template) ](#contributing-a-hrefhttpsgithubcommarketingpipelineawesome-repo-templategraphscontributors-githubhttpsimgshieldsiogithubcontributorsmarketingpipelineawesome-repo-template-a)

- [License  ![GitHub](https://img.shields.io/github/license/MarketingPipeline/Awesome-Repo-Template) ](#license-a-hreflicense-githubhttpsimgshieldsiogithublicensemarketingpipelineawesome-repo-template-a)

	

 

	


	 

 How to setup GitHub bots 




These are bots that are prepared and configured for this template. They need to be activated to properly work.







1. The `issue_label_bot.yaml` file depends on the **issue label bot** [Activate it or check its documentation](https://github.com/marketplace/issue-label-bot)(✓ highly recommended).

2. The `settings.yml` file depends on the **settings label bot** [Activate it or check its documentation](https://probot.github.io/apps/settings/) (optional).

3. The `config.yml` file depends on the bot **welcome bot** [Activate it or check its documentation](https://probot.github.io/apps/welcome/) and [to-do bot](https://probot.github.io/apps/todo/) (optional).

## Contributing  ![GitHub](https://img.shields.io/github/contributors/MarketingPipeline/Awesome-Repo-Template) 

Want to improve this template? Create a pull request with detailed changes / improvements! If approved you will be added to the list of contributors of this awesome repo template!

See also the list of

[contributors](https://github.com/MarketingPipeline/Awesome-Repo-Template/graphs/contributors) who

participate in this project.

## License  ![GitHub](https://img.shields.io/github/license/MarketingPipeline/Awesome-Repo-Template) 

This project is licensed under the MIT License - see the

[LICENSE.md](https://github.com/MarketingPipeline/Awesome-Repo-Template/blob/main/LICENSE) file for

details.