/cookiecutter-web

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

Primary LanguageTypeScriptApache License 2.0Apache-2.0

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 docker-compose.base.yaml -f docker-compose.prod.yaml up --build -d to deploy the application in production mode.

Run docker compose -f docker-compose.base.yaml -f docker-compose.prod.yaml -f docker-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 docker-compose.base.yaml -f docker-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.