Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/smcnab1/project-template-repo

Your starting point for streamlined project setups. Jumpstart your development with this versatile template. 🚀📁
https://github.com/smcnab1/project-template-repo

actions automation boilerplate generator jumpstart python readme repo repository template

Last synced: 4 days ago
JSON representation

Your starting point for streamlined project setups. Jumpstart your development with this versatile template. 🚀📁

Host: GitHub
URL: https://github.com/smcnab1/project-template-repo
Owner: smcnab1
License: mit
Created: 2024-01-01T14:45:08.000Z (11 months ago)
Default Branch: master
Last Pushed: 2024-06-15T11:20:37.000Z (5 months ago)
Last Synced: 2024-06-16T09:45:39.195Z (5 months ago)
Topics: actions, automation, boilerplate, generator, jumpstart, python, readme, repo, repository, template
Language: HTML
Homepage:
Size: 495 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
- Support: .github/SUPPORT.md

Awesome Lists containing this project

README

        

[![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]

[![Kofi][kofi-badge]][kofi-url]








  

    

  

Project Template Repo


  


    Jumpstart your development with this versatile template. 🚀📁

    


    Explore the docs »

    


    


    View Demo

    ·

    Report Bug

    ·

    Request Feature

  



  View Contents

_Last Updated DATE_

- [About The Project](#about-the-project)

  - [Features](#features)

  - [Built with](#built-with)

- [Getting started](#getting-started)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

- [Back Matter](#back-matter)

  - [Roadmap](#roadmap)

  - [Contributing](#contributing)

  - [License](#license)

  

## About The Project



  

    

  

  

  

This repository can be used as a template to load your new repository with ease. Including the following features to save your time in generating new repositories.

(back to top)


### Features

- Auto-Update Documentation Links with current repo name

- Update Email Addresses: CODE_OF_CONDUCT, SECURITY.

- Download files & folders from another GitHub Repo

- Generate Markdown styled index file with SEO details

- Generate Table of Contents into README

- Several files already created for you as a template

### Built with

- Markdown

- Python

- GitHub Actions

- Shell

(back to top)


## Getting started

### Prerequisites

Accessible using browser or GitHub mobile application.

### Install

1. Click on [use template](https://github.com/new?template_name=project-template-repo&template_owner=smcnab1) to generate new repository from template.

2. Enter repository name and Description.

3. Generate new repository.

4. Navigate to **Settings > Actions > General** and set ***Workflow Permissions*** to _Read and write permissions_

### Usage

- Repository Link Updater

    - WIP

- License Date Updater

    - WIP

- Code of Conduct Email Updater

    - WIP

- Security Policy Email Updater

    - WIP

- Table of Contents Generator

    - WIP

- Index File Generator

    - WIP

- Combinations

    - WIP

(back to top)


## Back Matter

### Roadmap

- [ ] Finalise Documentation.

- [ ] Remove need for config file, all set within Actions.

- [ ] Combination Selection instead of individual options.

See the [open issues](https://github.com/smcnab1/project-template-repo/issues) for a full list of proposed features (and known issues).

(back to top)




### 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" or "feature-request".

Don't forget to give the project a star! Thanks again!

1. Fork the Project.

2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)

3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)

4. Push to the Branch (`git push origin feature/AmazingFeature`)

5. Open a Pull Request

### License

This project is licensed under the [MIT License](LICENSE.md).

(back to top)


[contributors-shield]: https://img.shields.io/github/contributors/smcnab1/project-template-repo.svg?style=for-the-badge

[contributors-url]: https://github.com/smcnab1/project-template-repo/graphs/contributors

[forks-shield]: https://img.shields.io/github/forks/smcnab1/project-template-repo.svg?style=for-the-badge

[forks-url]: https://github.com/smcnab1/project-template-repo/network/members

[stars-shield]: https://img.shields.io/github/stars/smcnab1/project-template-repo.svg?style=for-the-badge

[stars-url]: https://github.com/smcnab1/project-template-repo/stargazers

[issues-shield]: https://img.shields.io/github/issues/smcnab1/project-template-repo.svg?style=for-the-badge

[issues-url]: https://github.com/smcnab1/project-template-repo/issues

[license-shield]: https://img.shields.io/github/license/smcnab1/project-template-repo.svg?style=for-the-badge

[license-url]: https://github.com/smcnab1/project-template-repo/blob/master/LICENSE.md

[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555

[linkedin-url]: https://www.linkedin.com/in/sammcnab/

[product-screenshot]: images/screenshot.png

[email-badge]: https://img.shields.io/badge/Email-D14836?style=for-the-badge&logo=gmail&logoColor=white

[email-url]: mailto:[email protected]

[git-badge]: https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white

[git-url]: https://github.com/smcnab1

[kofi-badge]: https://ko-fi.com/img/githubbutton_sm.svg

[kofi-url]: https://ko-fi.com/sammcnab1