From 18f52784c9d7c1670e74dda4c6cb45ad7a80653f Mon Sep 17 00:00:00 2001 From: "valentin.kozlov" Date: Wed, 21 Feb 2024 21:47:09 +0100 Subject: [PATCH] chore: Update Contributing --- CONTRIBUTING.md | 3 +++ README.md | 8 ++++---- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 81f7542..eecf1c2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,6 +6,9 @@ email, or any other method with the owners of this repository before making a ch Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project. +## Backend +For the backend, please, also see [backend/CODE OF CONDUCT](backend/CODE_OF_CONDUCT.md) and [backend/CONTRIBUTING](backend/CONTRIBUTING.md). + ## Reporting bugs Report bugs at https://github.com/m-team-kit/cookiecutter-web/issues diff --git a/README.md b/README.md index 670e6b4..1194b47 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-1.4-4baaaa.svg)](code_of_conduct.md) +[![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](https://cookiecutter.readthedocs.io/) templates, allowing the user to fill in the configuration online and download the generated project as a .zip file. @@ -13,9 +13,9 @@ 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 up --build` to deploy the application in production mode. +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.dev.yaml up --build` 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/](https://templates.services.fedcloud.eu/) @@ -27,7 +27,7 @@ In order to add a new template, please, follow the instructions at [https://gith 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 +This code is distributed under the Apache 2.0 License. Please, see the [LICENSE](LICENSE) file. # Authors and acknowledgment