Fortunately, we can create template repositories in GitHub which we can reuse (and modify) for future projects. In this lesson, we'll learn how to create a template repository in GitHub as well as how to use the template for other repositories.
First, we need to create a repository that includes all the files we want. We'll keep this example simple. It will include just a README. Go ahead and create a directory called
template-repo which includes the following
# (Application Name) #### (Brief Description of Application) #### By (Your Name Here) ## Technologies Used * _List all_ * _the major technologies_ * _you used in your project_ * _here_ ## Description ## Setup/Installation Requirements * _This is a great place_ * _to list setup instructions_ * _in a simple_ * _easy-to-understand_ * _format_ ## Known Bugs * _Any known issues_ * _should go here_ ## License ## Contact Information
As we can see, this README contains headers for all of the items that are required in the READMEs for projects we create at Epicodus.
The next step is to commit the code and push it to GitHub. Once that's finished, go to the repository in GitHub and click on Settings. Just to clarify, you need to go to the Settings for the specific repository, not for your GitHub profile.
As the image above shows, once you click on Settings, you can click the checkbox marked Template repository. A little green checkmark will pop up by the box, which means that GitHub has auto-saved the update.
After checking the box, navigate back to main page of the repository. You'll see it has a Template label by the name of the repository:
If there's not a Template label, you'll need to go back to the Settings and make sure you actually checked the box.
You'll also see that the repository now has a green Use This Template button.
If we want to create a new repository using this template, we just need to click the Use This Template button. We'll be taken to a page for creating a new repository. It looks almost exactly the same as the new repository page we've been using so far. The only difference is that we are now creating the repository from a template. We can create a repository as usual, but this time once the repository is created, all of the files from the template will be included in the new repository. Finally, we can clone the repository to our desktop and modify it as needed, changing the README or any other files it already has such as configuration or code files.
Using a template repository is especially helpful for projects that include boilerplate environments such as the ones we've been building in this section. We can easily create a template repository that includes a
package.json file, a webpack configuration, and any other configuration files such as what we might need for Babel or ESLint.
Now that you've created a template file, the next step is to create your own templates. Before you start working on your next project, create a template repository that includes all the files you need for the project. At the very least, it should include the following:
You can also include directories such as
When you create your template repository, take the time to add thorough installation/setup instructions to your README. This should include information on how to run the project (including steps such as
$ npm install) and how to run the project in the browser or run tests with Jest. Also, make sure you update the Techologies Used section of your README, too.
Template repositories can make it much easier to get started on a project. To really utilize a template repository effectively, you need to get it right. That's why it's worth taking a little extra time to put together a great template README now. If the README in the template repository is mediocre, chances are it will lead to mediocre READMEs in other projects, too - and a lot of additional work to get those READMEs in shape later down the road.
One final recommendation - while we do recommend getting specific about details such as installation steps, you don't want to make your templates so specific that they aren't reusable. If you find yourself regularly deleting content from repositories that have been built from a template, that's a sign that the content in the template isn't serving its purpose. You want to minimize the amount of boilerplate you need to add from scratch - but you also want to avoid having to delete a lot of boilerplate, too.
For more information on creating template repositories and reusing them, see the following GitHub documentation:
Lesson 41 of 46
Last updated November 24, 2021