Skip to content

m-team-kit/templates-hub

Repository files navigation

templates-hub

The Templates Hub is the place to collect software templates based on cookiecuters.

This collection is used by the Templates Hub service, running at https://templates.services.fedcloud.eu. Users can (search), list available templates, choose a template of their interest, and generate software project based on the selected template: simply fill out the corresponding web form and receive zip file with the customized startup software project.

How to add a new template entry

The template records are collected in this github repository. In order to add a new entry, one has to create Pull Request which will be reviewed by our members.

  1. Fork this repository
  2. (optional) Add a logo for your cookiecutter template, i.e. an image file in the pictures/ directory or use one of the available
  3. Create a new JSON file keeping convention githubuser-cookiecutter_repository.json
  4. Fill the content following the example below
  5. Commit your changes
  6. Create Pull Request to add your new file in our repository

Here is the JSON structure for adding a new cookiecutter template entry:

{
    "title": "Template name",
    "summary": "Short summary",
    "tags": [],
    "picture": "",
    "gitLink": "https://github.com/user/repository",
    "gitCheckout": "",
    "feedback": ""
}
  • "title": Template name, try to keep short but unique
  • "summary": Summary describing the template
  • "tags": add list of tages, e.g. programming language , target audience etc
  • "picture": a logo for your cookiecutter template, i.e. an image added in the pictures/ directory, e.g. pictures/cookiecutter_simple_small.png
  • "gitLink": URL to the repository of your template
  • "gitCheckout": either branch, tag, or commit for the template
  • "feedback": How you want to collect feedback about your template (e.g. github issues link, email list, etc)

About

Repository for software templates

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published