chore: Add Contributing, Code of conduct, Citation

CITATION.cff

@@ -0,0 +1,32 @@
+# 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

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [[email protected]]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# Contributing
+
+Contributions are welcome, and they are greatly appreciated! 
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before making a change. 
+
+Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
+
+
+## Reporting bugs
+Report bugs at https://github.com/m-team-kit/cookiecutter-web/issues
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* If you can, provide detailed steps to reproduce the bug.
+* If you don't have steps to reproduce the bug, just note your observations in
+  as much detail as you can. Questions to start a discussion about the issue
+  are welcome.
+
+### Submit Feedback
+The best way to send feedback is to file an issue at the follwing URL:
+
+https://github.com/m-team-kit/cookiecutter-web/issues
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+## Pull Request Process
+
+You are welcome to open Pull Requests for either fixing a bug, adding a new feature, contributing to the documentation, etc.
+
+1. Fork the repository and create a new branch from `main`.
+2. If you’ve fixed a bug or added code that should be tested, add tests!
+3. Make sure your code lints (e.g. flake8 for python; eslint, prettier for next.js).
+4. Update the README.md with details of changes, e.g. new environment variables, 
+   exposed ports, container parameters etc.
+5. Increase the version numbers in any examples files and the README.md to the new version that this
+   Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
+6. Push the changes to your fork.
+7. Create a Pull Request to this repository.
+8. Review and address comments on your pull request.
+
+
+
+

README.md

@@ -1,6 +1,7 @@
-# Cookiecutter-Web
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-1.4-4baaaa.svg)](code_of_conduct.md)
+# 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.
+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.
 
 The frontend is built in [next.js](https://nextjs.org/) and can be found in `/frontend`.
 
@@ -12,6 +13,23 @@ Copy `.env-example` to `.env` and refer to the comments to fill in desired confi
 
 # Running the application
 
-Run `docker-compose -f docker-compose.base.yaml -f docker-compose.prod.yaml --build up` to deploy the application in production mode.
+Run `docker compose -f docker-compose.base.yaml -f docker-compose.prod.yaml up --build` to deploy the application in production mode.
 
-Run `docker-compose -f docker-compose.base.yaml -f docker-compose.dev.yaml --build up` to deploy the application in development mode for testing.
+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](https://github.com/m-team-kit/templates-hub)
+
+
+# Contributing
+Please, see our [CONTRIBUTING](CONTRIBUTING.md) description and the [CODE OF CONDUCT](CODE_OF_CONDUCT.md).
+
+# License
+This code is distributed under the Apache 2.0 License. Please, see the [LICENSE](LICENSE) file
+
+# Authors and acknowledgment
+
+@Authors: Borja Esteban, Christophe Laures, Valentin Kozlov (KIT)
+Copyright (c) 2023 - 2024 Karlsruhe Institute of Technology - Scientific Computing Center.