Get locking information for note and add GitHub action for automatic deploying

.github/workflows/deploy.yml

@@ -0,0 +1,29 @@
+name: Build and Deploy
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+permissions:
+  contents: write
+jobs:
+  build-and-deploy:
+    concurrency: ci-${{ github.ref }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout️
+        uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      - name: Install and Build
+        run: |
+          npm ci
+          npm run build
+
+      - name: Deploy
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: build

README.md

@@ -37,6 +37,13 @@ To build the app run `docker compose exec editor yarn run build`.
 
 ### Deployment
 
+#### Automatic
+
+1. To make the source code prettier, run `yarn pretty`.
+1. By default, whenever you push a commit to the `main` branch, a github action will run, build your project, and deploy to the `gh-pages` branch on GitHub. If you do not want to use this feature, please remove the `.github/workflows/deploy.yml` file.
+
+#### Manual
+
 1. To make the source code prettier, run `yarn pretty`.
 1. To the deploy the build into the `gh-pages` branch of your repository on GitHub, run `yarn deploy-stable`.
 1. To deploy the build into to the `dev` branch for testing, run `yarn deploy-dev`.