From 8d914f23475db3659a32079d8b004d55e309099f Mon Sep 17 00:00:00 2001 From: "Samuel T." Date: Thu, 12 Dec 2024 12:13:40 -0500 Subject: [PATCH 1/3] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9c493fff..3cd8f3ef 100644 --- a/README.md +++ b/README.md @@ -67,12 +67,14 @@ For backend ```shell cd canopeum_backend - docker compose up + # docker compose up # SEE NOTE BELOW ! uv sync --locked uv run manage.py initialize_database uv run manage.py runserver ``` + Note: The docker compose file has bee updated for production deployment a while ago and no alternative has been created for local deployment. We currently use the `start-local-env.ps1` script with option `2: Run MySQL container`. If anyone wants to contribute restoring a simple docker command for dev, it would be more than welcome. + 5. Set up React frontend: ```shell From 03bd780881fd69e9cbffe2cc3fce69d1e73a342a Mon Sep 17 00:00:00 2001 From: "Samuel T." Date: Thu, 12 Dec 2024 12:18:18 -0500 Subject: [PATCH 2/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3cd8f3ef..9bf2cf56 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ For backend uv run manage.py runserver ``` - Note: The docker compose file has bee updated for production deployment a while ago and no alternative has been created for local deployment. We currently use the `start-local-env.ps1` script with option `2: Run MySQL container`. If anyone wants to contribute restoring a simple docker command for dev, it would be more than welcome. + Note: The docker compose file has bee updated for production deployment a while ago and no alternative has been created for local development. We currently use the `start-local-env.ps1` script with option `2: Run MySQL container`. If anyone wants to contribute restoring a simple docker command for dev, it would be more than welcome. 5. Set up React frontend: From 0076ba67f9a57996c9efbd7d91f1b77418d65295 Mon Sep 17 00:00:00 2001 From: Samuel Therrien Date: Thu, 12 Dec 2024 14:22:04 -0500 Subject: [PATCH 3/3] Update deployment process and Linux prerequesites --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9bf2cf56..6c3abc6f 100644 --- a/README.md +++ b/README.md @@ -21,17 +21,23 @@ with the docker-compose.yml from this repository. ### Prerequisites -For frontend: +#### For frontend - [Node.js](https://nodejs.org/en/download) (includes npm) - [Mockoon](https://mockoon.com/download/#download-section) -For backend +#### For backend - [Python 3.12](https://www.python.org/downloads/) - [UV](https://docs.astral.sh/uv/getting-started/installation/#standalone-installer) - [Docker](https://www.docker.com/get-started/) +On Linux you must instal the mysql dev binaries to be able to build the `mysqlclient` python distribution. + +- Debian / Ubuntu: `apt-get install default-libmysqlclient-dev` +- Red Hat / CentOS: `yum install mysql-devel` +- Arch: `pacman -S mysql` + ### Installation 1. Fork the project:\ @@ -180,6 +186,8 @@ If you save a modification to the `.nswag` file, DO NOT INCLUDE THE LOCAL COPY O ## Deployments -Whenever changes are pushed to the main branch, a build is automatically triggered and a container package pushed to . An administrator must then navigate to `/#!/1/docker/stacks/releaf-canopeum?id=11®ular=true` on our portainer instance and press "Pull and redeploy". +Whenever changes are pushed to the main branch, a build is automatically triggered and a container package pushed to . + +You can also trigger a manual package build by using the "Run workflow" button at . -You can also trigger a manual package build by using the "Run workflow" button at . We'd prefer this to be the only action necessary for a deployment, so that any maintainer on GitHub could redeploy, but our automated detection on portainer currently isn't working. +