The common project template with Cookiecutter support

A common project template to start of, batteries included and Cookiecutter-compatible.

https://gitlab.com/the-common/cookiecutter-project

Usage

Information on how to use this product:

Prerequisites

Before using this product, ensure you have the following prerequisites installed:

• Cookiecutter
  For generating the project from template.
• Git
  For downloading the project template.
• (OPTIONAL) Project initializer
  Only needed if you want to automate GitLab and GitHub project setup.

Usage instructions

To use this project template, follow these steps:

1. Launch a text terminal.

2. Run the following command to switch the working directory to your desired location to place the project:

   cd /path/to/your/desired/location

   Replace /path/to/your/desired/location with the actual path to the directory where you want to create the new project.

3. Run the following command to generate a new project from the template:

   cookiecutter gl:the-common/cookiecutter-project

   Follow the prompts to enter the required information for your new project.

4. Navigate to the newly created project directory:

   cd your_project_slug

   Replace your_project_slug with the actual slug of your new project.

5. (OPTIONAL) Run the following command to initialize the Git repository:

   git init

6. (OPTIONAL) Run the following command to automate the repository setup using the project initializer:

   project-initializer

7. Start hacking!

References

The following materials are referenced during the development of this product:

• Usage — cookiecutter documentation
  Provide information regarding the abbreviation of GitLab-hosted repo templates.

Licensing

Unless otherwise noted(comment headers/REUSE.toml), this product is licensed under the 4.0 International version of the Creative Commons Attribution-SharedAlike license, or any of its more recent versions of your preference.

As an exception of the previous clause, this product can be licensed otherwise under the 2.0 version of the Apache license if it is used to instantiate/refactor a project based on it rather than using it in the making of another template project. This allows relicensing the project assets to your liking in your non-template projects with only a conformance requirement of attributing this product somewhere in your project/product credits/acknowledgment/copyright notice documentation/user interface.

This work complies to the REUSE Specification, refer to the REUSE - Make licensing easy for everyone website for info regarding the licensing of this product.