docs: add vm and bare metal workflows flow chart

Author: marcelovicentegc

.github/workflows/deploy-bare-metal.yml

@@ -70,7 +70,7 @@ jobs:
           username: ${{ secrets.USERNAME }}
           password: ${{ secrets.SSH_PASSWORD }}
           port: 22
-          source: "requirements.txt,api,backend,config,core,frontend,manage.py,drt.ini"
+          source: "poetry.lock,pyproject.toml,api,backend,config,core,frontend,manage.py"
           target: "app_to_deploy"
 
       - name: build the backend, the frontend and start the app's daemon
@@ -121,13 +121,17 @@ jobs:
             echo -e "~~~~~~~~~~~~~~~~~~~~~~~~ Replaced current running code with new one ~~~~~~~~~~~~~~~~~~~~~~~~\n"
 
             cd app
-            python3 -m pip install -r requirements.txt
+            python3 -m pip install --upgrade pip
+            pip install poetry
+            poetry install --no-dev
             echo -e "~~~~~~~~~~~~~~~~~~~~~~~~ Installed python requirements successfully ~~~~~~~~~~~~~~~~~~~~~~~~\n"
 
-            python3 manage.py migrate && python3 manage.py collectstatic --no-input && python3 manage.py clearcache
+            poetry run python3 manage.py migrate
+            poetry run python3 manage.py collectstatic --no-input
+            poetry run python3 manage.py clearcache
 
             echo ${{ secrets.SSH_PASSWORD }} | sudo -S rm /etc/supervisord.d/drt.ini
-            echo ${{ secrets.SSH_PASSWORD }} | sudo -S cp ./drt.ini /etc/supervisord.d/
+            echo ${{ secrets.SSH_PASSWORD }} | sudo -S cp ./config/supervisor/drt.ini /etc/supervisord.d/
             echo ${{ secrets.SSH_PASSWORD }} | sudo -S supervisorctl update
             echo ${{ secrets.SSH_PASSWORD }} | sudo -S supervisorctl reread
             echo ${{ secrets.SSH_PASSWORD }} | sudo -S supervisorctl status drt

README.md

@@ -106,11 +106,52 @@ Nonetheless, this codebase has two deploy methods available via GitHub actions:
 
 The `vm-deploy` branch will trigger this wokflow. You can use it to deploy the app to any Virtual Machine accessible via SSH (AWS EC2s, GCloud apps, Digital Ocean droplets, Hostgator VPSs, etc), and you would likely want to change the name of these branches to something more meaningful to your project.
 
+This is what the workflow does:
+
+```mermaid
+flowchart LR
+    nv("Make changes to\nthe application") -- Commit --> n7("Build and test frontend\nand backend")
+    n7 --> nf{"Success?"}
+    nf -- Yes --> n2("Build and test docker\nimage")
+    nf -- No --> n4("Cancel pipeline")
+    n2 --> n5{"Success?"}
+    n5 -- No --> n4
+    n5 -- Yes --> nx("Publish docker image\nto GitHub packages")
+    nx --> nj{"Success?"}
+    nj -- No --> n4
+    nj -- Yes --> nd("Deploy")
+    nd --> nc("Login into VM and copy\ndocker compose file\nfrom repo")
+    nc --> n6{"Success?"}
+    n6 -- Yes --> no("Pull previously pushed Docker image\nand execute most recent\n docker compose file")
+    n6 -- No --> n4
+    no --> na{"Success?"}
+    na -- No --> ng("Better check your\nsystem's health")
+    na -- Yes --> nk("Updates are live")
+```
+
 ### Bare-metal Deploy Workflow
 
-The `bare-metal-deploy` branches will trigger this workflow. You can use it to deploy the app straight on the host machine, without any virtualization. This is not recommended, but ou never know when you will need to deploy an app on a bare-metal machine 🤷‍♀️
+The `bare-metal-deploy` branches will trigger this workflow. You can use it to deploy the app straight on the host machine, without any virtualization. This is not recommended, but ou never know when you will need to deploy an app on a bare-metal machine 🤷‍♀️. This pipeline assumes that you've got Node.js, Python, [Gunicorn](https://gunicorn.org/) and [Supervisord](http://supervisord.org/) installed on the host machine.
 
-You should configure these variables on a `.env` file on the root folder for the global configuration and a `.env` file for the frontend configuration under `frontend/.env` when developing. As for deploying the app, **you will need to set the same set of dev variables + some variables exclusively used in production environments as [_secrets_](https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets)**.
+This is what the workflow does:
+
+```mermaid
+flowchart LR
+    nv("Make changes to\nthe application") -- Commit --> n7("Build and test frontend\nand backend")
+    n7 --> nf{"Success?"}
+    nf -- Yes --> n2("Logs into host machine\nand copy all relevant files\nfrom repo to it")
+    nf -- No --> n4("Cancel pipeline")
+    n2 --> n5{"Success?"}
+    n5 -- No --> n4
+    n5 -- Yes --> nx("Builds the frontend\nand the backend")
+    nx --> nj{"Success?"}
+    nj -- No --> n4
+    nj -- Yes --> nd("Deploy")
+    nd --> nc("Starts gunicorn server under\nsupervisor to ensure the\nsystem is never down")
+    na{"Success?"} -- No --> ng("Better check your\nsystem's health")
+    na -- Yes --> nk("Updates are live")
+    nc --> na
+```
 
 ### Configuration
 

assets/Architecture.png

@@ -1,6 +1,6 @@
 {
   "name": "django-react-typescript-frontend",
-  "version": "1.0.0",
+  "version": "0.1.0",
   "main": "index.js",
   "repository": "https://github.com/marcelovicentegc/django-react-typescript.git",
   "author": "Marcelo Cardoso <dev@marcelo.page>",
@@ -38,8 +38,6 @@
     "@babel/core": "^7.24.7",
     "@babel/preset-env": "^7.24.7",
     "@babel/preset-react": "^7.24.7",
-    "@commitlint/cli": "^8.3.5",
-    "@commitlint/config-conventional": "^8.3.4",
     "@types/node": "^20.14.6",
     "@types/react": "^18.3.3",
     "@types/react-dom": "^18.3.0",
@@ -48,7 +46,6 @@
     "copy-webpack-plugin": "^5.1.1",
     "cross-env": "^6.0.3",
     "source-map-loader": "^0.2.4",
-    "husky": "^4.2.5",
     "ts-loader": "^6.2.1",
     "internal-ip": "^5.0.0",
     "concurrently": "^8.2.2",

assets/DeployWorkflow.jpg

@@ -1,7 +1,7 @@
 {
   "name": "django-react-typescript",
-  "version": "1.0.0",
-  "description": "<p align=\"center\">   <img alt=\"django-react-typescript logo\" src=\"assets/Logo.png\" />   <p align=\"center\">Your favorite React-Django boilerplate.</p> </p>",
+  "version": "0.1.0",
+  "description": "This is an non-opinionated Django + React boilerplate built with great development experience and easy deployment in mind.",
   "scripts": {
     "bootstrap": "concurrently -n global,backend,frontend \"pnpm i\" \"poetry install\" \"cd frontend && pnpm i\"",
     "setup:env": "sh ./scripts/setup_env.sh",

drt.ini renamed to config/supervisor/drt.ini

@@ -1,8 +1,8 @@
 [tool.poetry]
 name = "django-react-typescript"
-description = ""
+description = "This is an non-opinionated Django + React boilerplate built with great development experience and easy deployment in mind."
 authors = ["marcelovicentegc <marcelovicentegc@gmail.com>"]
-license = "ISC"
+license = "MIT"
 readme = "README.md"
 package-mode = false