docs(readme): add project structure section

Reviewed-on: #2
Reviewed-by: Jakob Gregory

.gitea/workflows/deploy-on-prod.yml

@@ -0,0 +1,37 @@
+name: Deploy on production
+
+on:
+  release:
+    types:
+      - published
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+    name: Deploy on production
+
+    runs-on: node-minio
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set alias
+        run: |
+          mc alias set minio "${{ vars.S3_PROD_URL }}" "${{ secrets.S3_PROD_ACCESS_KEY }}" "${{ secrets.S3_PROD_SECRET_KEY }}"
+
+      - name: Upload assets to MinIO
+        shell: bash
+        run: |
+          set -euo pipefail
+
+          BUCKET="${{ vars.S3_PROD_BUCKET_NAME }}"
+          BUILD_ID=$(date -u +%Y-%m-%d)-$(git rev-parse --short HEAD)
+
+          echo "Build ID: $BUILD_ID"
+
+          mkdir -p ./src
+
+          mc cp --recursive ./src/ "minio/$BUCKET/builds/$BUILD_ID"
+          echo "Copied files successfully"

README.md

@@ -1,3 +1,15 @@
-# repository-template
+# frontend-assets
 
-The template for repositories
+The assets for the frontend of the search engine *Seekra*
+
+## Project structure
+
+All assets are located in subfolders for their asset type in `src/`. Assets types are:
+
+- Fonts (`fonts`)
+- Images (`images`)
+- Videos (`videos`)
+- Audio (`audio`)
+- Icons (`icons`)
+
+There are also some special `src/` subfolders like those for legal content.