cookiecutter-web

An application that reads a cookiecutter.json file and parses it to a webform

https://github.com/m-team-kit/cookiecutter-web

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (8.9%) to scientific vocabulary

Keywords

cookiecutter templates web-service
Last synced: 9 months ago · JSON representation ·

Repository

An application that reads a cookiecutter.json file and parses it to a webform

Basic Info
  • Host: GitHub
  • Owner: m-team-kit
  • License: apache-2.0
  • Language: TypeScript
  • Default Branch: main
  • Homepage:
  • Size: 2.7 MB
Statistics
  • Stars: 1
  • Watchers: 3
  • Forks: 1
  • Open Issues: 0
  • Releases: 4
Topics
cookiecutter templates web-service
Created about 3 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Codemeta

README.md

SQAaaS badge

Contributor Covenant

Cookiecutter-Web or Templates Hub

This application provides a 'marketplace' for commonly used cookiecutter templates, allowing the user to fill in the configuration online and download the generated project as a .zip file.

The frontend is built in next.js and can be found in /frontend.

The backend source is hosted on the backend repository.

Configuration

Copy .env-example to .env and refer to the comments to fill in desired configuration values.

Running the application

Run docker compose -f compose.base.yaml -f compose.prod.yaml up --build -d to deploy the application in production mode.

Run docker compose -f compose.base.yaml -f compose.prod.yaml -f compose.frontend-only.yaml up --build -d to deploy the application with the frontend only (e.g. to have different frontends with still the same backend hosted on another instance).

Run docker compose -f compose.base.yaml -f compose.dev.yaml up --build to deploy the application in development mode for testing.

Deployed service

Deployed service can be found in https://templates.services.fedcloud.eu/

In order to add a new template, please, follow the instructions at https://github.com/m-team-kit/templates-hub

Contributing

Please, see our CONTRIBUTING description and the CODE OF CONDUCT.

License

This code is distributed under the Apache 2.0 License. Please, see the LICENSE file.

Authors and acknowledgment

@Authors: Borja Esteban, Christophe Laures, Valentin Kozlov (KIT) Copyright (c) 2023 - 2024 Karlsruhe Institute of Technology - Scientific Computing Center.

Owner

  • Name: m-team-kit
  • Login: m-team-kit
  • Kind: organization

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: cookiecutter-web
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Christophe
    family-names: Laures
    affiliation: KIT
  - given-names: Borja
    family-names: Esteban
    affiliation: KIT
  - given-names: Valentin
    family-names: Kozlov
    affiliation: KIT
repository-code: >-
  https://codebase.helmholtz.cloud/m-team/ai/cookiecutter-web/
url: 'https://templates.services.fedcloud.eu/'
abstract: >-
  This application provides a 'marketplace' for commonly
  used [cookiecutter](https://cookiecutter.readthedocs.io/)
  templates, allowing the user to fill in the configuration
  online and download the generated project as a .zip file.
keywords:
  - templates
  - web service
  - cookiecutter
license: Apache-2.0

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "license": "https://spdx.org/licenses/Apache-2.0",
  "codeRepository": "git+https://codebase.helmholtz.cloud/m-team/ai/cookiecutter-web/",
  "issueTracker": "https://github.com/m-team-kit/cookiecutter-web/issues",
  "name": "cookiecutter-web",
  "description": "This application provides a 'marketplace' for commonly used [cookiecutter](https://cookiecutter.readthedocs.io/) templates, allowing the user to fill in the configuration online and download the generated project as a .zip file.",
  "applicationCategory": "Software templates",
  "keywords": [
    "templates",
    "cookiecutter",
    "web service"
  ],
  "programmingLanguage": [
    "Javascript",
    "Python"
  ],
  "relatedLink": [
    "https://templates.services.fedcloud.eu/"
  ],
  "author": [
    {
      "@type": "Person",
      "givenName": "Christophe",
      "familyName": "Laures",
      "affiliation": {
        "@type": "Organization",
        "name": "KIT"
      }
    },
    {
      "@type": "Person",
      "givenName": "Borja",
      "familyName": "Esteban",
      "affiliation": {
        "@type": "Organization",
        "name": "KIT"
      }
    },
    {
      "@type": "Person",
      "givenName": "Valentin",
      "familyName": "Kozlov",
      "affiliation": {
        "@type": "Organization",
        "name": "KIT"
      }
    }
  ]
}

GitHub Events

Total
  • Release event: 1
  • Delete event: 3
  • Push event: 4
  • Create event: 5
Last Year
  • Release event: 1
  • Delete event: 3
  • Push event: 4
  • Create event: 5

Dependencies

.github/workflows/github-to-gitlab.yml actions
  • actions/checkout v2 composite
  • vykozlov/git-repo-sync v0.1.0 composite
frontend/Dockerfile docker
  • base latest build
  • node 18 build
frontend/package.json npm
  • prettier ^2.8.1 development
  • @types/node 18.11.9
  • @types/react 18.0.25
  • @types/react-dom 18.0.9
  • bootstrap ^5.2.3
  • clsx ^1.2.1
  • eslint 8.27.0
  • eslint-config-next 13.0.3
  • next 13.0.3
  • normalize.css ^8.0.1
  • oidc-client-ts ^2.2.0
  • react 18.2.0
  • react-dom 18.2.0
  • react-oidc-context ^2.2.0
  • react-query ^3.39.2
  • sass ^1.62.1
  • typescript 4.9.3
frontend/yarn.lock npm
  • 276 dependencies
frontend/lib/client/package.json npm
  • @types/node ^18.16.17 development
  • typescript ^5.1.6 development
  • axios ^1.4.0