feat: database backup script

* docs: update README.md [skip ci]

* docs: update .all-contributorsrc [skip ci]

---------

Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>

.all-contributorsrc

@@ -105,6 +105,24 @@
       "contributions": [
         "bug"
       ]
+    },
+    {
+      "login": "benpsnyder",
+      "name": "Ben Snyder",
+      "avatar_url": "https://avatars.githubusercontent.com/u/707567?v=4",
+      "profile": "https://snyder.tech",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "cloudsbird",
+      "name": "Vederis Leunardus",
+      "avatar_url": "https://avatars.githubusercontent.com/u/13505006?v=4",
+      "profile": "http://vederis.id",
+      "contributions": [
+        "code"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.github/workflows/build-deploy-container.yml

@@ -12,20 +12,37 @@ env:
 
 jobs:
   build-publish-webapp:
+    strategy:
+      fail-fast: false
+      matrix:
+        platform:
+          - linux/amd64
+          - linux/arm64
     name: Build and deploy webapp container
     runs-on: ubuntu-latest
     environment: production
     steps:
+      - name: Prepare
+        run: |
+          platform=${{ matrix.platform }}
+          echo "PLATFORM_PAIR=${platform//\//-}" >> $GITHUB_ENV
+
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
 
       # Login to Container registry.
       - name: Log in to the Container registry
-        uses: docker/login-action@v1
+        uses: docker/login-action@v3
         with:
-            registry: ${{ env.REGISTRY }}
+          registry: ${{ env.REGISTRY }}
-            username: ${{ github.actor }}
+          username: ${{ github.actor }}
-            password: ${{ secrets.GH_TOKEN }}
+          password: ${{ secrets.GH_TOKEN }}
 
       - name: Extract metadata (tags, labels) for Docker
         id: meta
@@ -35,14 +52,29 @@ jobs:
 
       # Builds and push the Docker image.
       - name: Build and push Docker image
-        uses: docker/build-push-action@v2
+        uses: docker/build-push-action@v5
+        id: build
         with:
-            context: .
+          context: .
-            file: ./packages/webapp/Dockerfile
+          file: ./packages/webapp/Dockerfile
-            push: true
+          platforms: ${{ matrix.platform }}
-            tags: ghcr.io/bigcapitalhq/webapp:latest
+          push: true
-            labels: ${{ steps.meta.outputs.labels }}
+          tags: ghcr.io/bigcapitalhq/webapp:latest
+          labels: ${{ steps.meta.outputs.labels }}
 
+      - name: Export digest
+        run: |
+          mkdir -p /tmp/digests
+          digest="${{ steps.build.outputs.digest }}"
+          touch "/tmp/digests/${digest#sha256:}"
+
+      - name: Upload digest
+        uses: actions/upload-artifact@v4
+        with:
+          name: digests-main-${{ env.PLATFORM_PAIR }}
+          path: /tmp/digests/*
+          if-no-files-found: error
+          retention-days: 1
       # Send notification to Slack channel.
       - name: Slack Notification built and published webapp container successfully.
         uses: rtCamp/action-slack-notify@v2
@@ -53,12 +85,23 @@ jobs:
     name: Build and deploy server container
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout code
+      - name: Prepare
-        uses: actions/checkout@v2
+        run: |
+          platform=${{ matrix.platform }}
+          echo "PLATFORM_PAIR=${platform//\//-}" >> $GITHUB_ENV
+
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
 
       # Login to Container registry.
       - name: Log in to the Container registry
-        uses: docker/login-action@v1
+        uses: docker/login-action@v3
         with:
           registry: ${{ env.REGISTRY }}
           username: ${{ github.actor }}
@@ -66,14 +109,30 @@ jobs:
 
       # Builds and push the Docker image.
       - name: Build and push Docker image
-        uses: docker/build-push-action@v2
+        uses: docker/build-push-action@v5
+        id: build
         with:
           context: ./
           file: ./packages/server/Dockerfile
+          platforms: ${{ matrix.platform }}
           push: true
           tags: ghcr.io/bigcapitalhq/server:latest
           labels: ${{ steps.meta.outputs.labels }}
 
+      - name: Export digest
+        run: |
+          mkdir -p /tmp/digests
+          digest="${{ steps.build.outputs.digest }}"
+          touch "/tmp/digests/${digest#sha256:}"
+  
+      - name: Upload digest
+        uses: actions/upload-artifact@v4
+        with:
+          name: digests-main-${{ env.PLATFORM_PAIR }}
+          path: /tmp/digests/*
+          if-no-files-found: error
+          retention-days: 1
+          
       # Send notification to Slack channel.
       - name: Slack Notification built and published server container successfully.
         uses: rtCamp/action-slack-notify@v2

.github/workflows/e2e.yml

@@ -8,14 +8,14 @@ on:
       - '**.ts'
       - '**.tsx'
       - '**/tsconfig.json'
-      - 'yarn.lock'
+      - 'pnpm-lock.yaml'
       - '.github/workflows/e2e.yml'
   pull_request:
     paths:
       - '**.ts'
       - '**.tsx'
       - '**/tsconfig.json'
-      - 'yarn.lock'
+      - 'pnpm-lock.yaml'
       - '.github/workflows/e2e.yml'
 
 defaults:

.husky/commit-msg

@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-yarn commitlint --edit 
+pnpx commitlint --edit 

README.md

@@ -122,6 +122,8 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/ANasouf"><img src="https://avatars.githubusercontent.com/u/19536487?v=4?s=100" width="100px;" alt="ANasouf"/><br /><sub><b>ANasouf</b></sub></a><br /><a href="https://github.com/bigcapitalhq/bigcapital/commits?author=ANasouf" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://ragnarlaud.dev"><img src="https://avatars.githubusercontent.com/u/3042904?v=4?s=100" width="100px;" alt="Ragnar Laud"/><br /><sub><b>Ragnar Laud</b></sub></a><br /><a href="https://github.com/bigcapitalhq/bigcapital/issues?q=author%3Axprnio" title="Bug reports">🐛</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/asenawritescode"><img src="https://avatars.githubusercontent.com/u/67445192?v=4?s=100" width="100px;" alt="Asena"/><br /><sub><b>Asena</b></sub></a><br /><a href="https://github.com/bigcapitalhq/bigcapital/issues?q=author%3Aasenawritescode" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://snyder.tech"><img src="https://avatars.githubusercontent.com/u/707567?v=4?s=100" width="100px;" alt="Ben Snyder"/><br /><sub><b>Ben Snyder</b></sub></a><br /><a href="https://github.com/bigcapitalhq/bigcapital/commits?author=benpsnyder" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://vederis.id"><img src="https://avatars.githubusercontent.com/u/13505006?v=4?s=100" width="100px;" alt="Vederis Leunardus"/><br /><sub><b>Vederis Leunardus</b></sub></a><br /><a href="https://github.com/bigcapitalhq/bigcapital/commits?author=cloudsbird" title="Code">💻</a></td>
     </tr>
   </tbody>
 </table>

lerna.json

@@ -2,6 +2,7 @@
   "$schema": "node_modules/lerna/schemas/lerna-schema.json",
   "version": "independent",
   "npmClient": "pnpm",
-  "useWorkspaces": true,
+  "packages": [
-  "packages": ["packages/*"]
+    "packages/*"
+  ]
 }

package.json

@@ -19,7 +19,8 @@
     "@faker-js/faker": "^8.0.2",
     "@playwright/test": "^1.32.3",
     "husky": "^8.0.3",
-    "lerna": "^6.4.1"
+    "lerna": "^8.1.2",
+    "pnpm": "^9.0.5"
   },
   "engines": {
     "node": "16.x || 17.x || 18.x"

packages/server/.gitignore

@@ -4,3 +4,5 @@ stdout.log
 /dist
 /build
 /public/imports
+
+dist

packages/webapp/.gitignore

@@ -20,4 +20,5 @@
 .env.production.local
 
 npm-debug.log*
-yarn-debug.log*
+
+dist

pnpm-workspace.yaml

@@ -1,2 +0,0 @@
-packages:
-  - "packages/*"

scripts/backup.sh

@@ -0,0 +1,24 @@
+# Takes a backup of database Docker volume and compress into one .tar.gz
+# file and upload to s3 package through s3cmd.
+S3_BUCKET="s3://bigcapital-backup"
+
+# Generate the current date and time formatted as YYYY-MM-DD-HH-MM-SS
+CURRENT_DATETIME=$(date +"%Y-%m-%d-%H-%M-%S")
+
+# Define the filename with the current date and time
+FILE_NAME="bigcapital-mariadb-${CURRENT_DATETIME}.tar.gz"
+
+# Create a sample file (replace this with your actual file creation process)
+echo "This is a sample file created on ${CURRENT_DATETIME}" > "$FILE_NAME"
+
+docker run --rm \
+  --mount source=bigcapital_prod_mysql,target=/data/db \
+  -v $(pwd):/backup \
+  busybox \
+  tar -czvf "/backup/$FILE_NAME" /data/db
+
+# Upload the file to S3 using s3cmd
+s3cmd put "$FILE_NAME" "$S3_BUCKET/"
+
+# Remove the temporary file
+rm "$FILE_NAME"

scripts/store-backup.sh

@@ -0,0 +1,7 @@
+
+# Store the backup.
+docker run --rm \
+  --mount source=bigcapital_dev_mysql,target=/data/db \
+  -v $(pwd):/backup \
+  busybox \
+  tar -xzvf /backup/bigcapital-mariadb-2024-04-24-15-14-40.tar.gz -C /