coldbreu / template

A template for github repositories

Repository Template

Simple repository template to get started with GitHub.

Report Bug · Request Feature

About The Project

A simple repository template to get started with GitHub.

Starting a new project? Say goodbye to repetitive setup tasks and configuration headaches! Simplify your workflow, save time, and ensure consistency across projects.

Let's make starting new projects feel like a breeze again.

(back to top)

Getting Started

1. Creating a repository

Click the green "Use this template" button in the top right corner of the page or the button below to create your new repository.

2. Run the setup script

Note

Only Node.Js versions 16, 18, 20 and latest are officially supported.

Run the following command and answer the prompts to complete the setup.

node ./dist/setup.js

3. Final touches

You are almost ready to start building your project. Just a few more steps and you're ready to go!

• Update CITATION.cff file with your project information.
• Create and add project images to the images/ directory and update README.md file.
• Update LICENSE.txt file with your preferred license.
• Update .github/CODESTYLE.md with your project's preferred code style.
• Update CONTRIBUTING.md with your project's preferred contribution guidelines.
• Update the workflow files in the .github/workflows/ directory.

Note

We know that there is still a fair amount of manual setup required, and we are committed to making this process as smooth and painless as possible.

If you have any feedback, please feel free to create an issue or a pull request.

Want to support this project? ✨ Star it on GitHub and help us spread the word!

(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". 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

Read our contributing guide for more information.

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Alex - [email protected]

(back to top)

Acknowledgments

• Choose an Open Source License
• GitHub Emoji Cheat Sheet
• Malven's Flexbox Cheatsheet
• Malven's Grid Cheatsheet
• Img Shields

(back to top)