Cookiecutter Templates to bootstrap different projects.
For standards and conventions used in this repository, please refer to the section at the end of this README.
On macOS with homebrew present, Cookiecutter is available as a ready to install package using the following shell command.
brew install cookiecutterOn a Debian based distribution, Cookiecutter is available as a ready to install package using the following shell command.
sudo apt-get install cookiecutterIf your setup differs, you can read the general installation instructions from the Cookiecutter documentation.
The most simple way to use the cookiecutter templates is to prepare a ~/.cookiecutterrc file. For this repository with the following content, replacing the placeholder values.
default_context:
user_fullname: "Your Name"
user_email: "[email protected]"
user_name: "username, eg. your github username"
team_name: "teamname, eg. your github user/teamname"
team_email: "[email protected]"
repository_namespace: "myteam"
# project_name: "Does not make sense to give a default here"
# project_description_short: "Does not make sense to give a default here."
# repository_name: "Does not make sense to give a default here"
# container_name: "Does not make sense to give a default here"
container_registry_namespace: "myteam"
abbreviations:
refnode: [email protected]:refnode/cookiecutter-templates.git
# for testing purpose
# cookiecutters_dir: "."The repository uses/follows the following standards/conventions:
-
Git Basic Standards (ignore / attributes)