Merge pull request #2 from scpwiki/deploy

Update deployment for attribution-metadata
scpwiki · Nov 22, 2023 · 34d69ea · 34d69ea
2 parents 2453dae + 3db5368
commit 34d69ea
Show file tree

Hide file tree

Showing 19 changed files with 79 additions and 35 deletions.
diff --git a/.github/workflows/check.yaml → .github/workflows/api-check.yaml b/.github/workflows/check.yaml → .github/workflows/api-check.yaml
@@ -3,11 +3,8 @@ name: 'Rust Build'
 on:
   push:
     paths:
-      - '.github/workflows/check.yaml'
-      - 'Cargo.toml'
-      - 'Cargo.lock'
-      - 'src/**'
-      - 'build.rs'
+      - '.github/workflows/api-check.yaml'
+      - 'api/**'
 
 jobs:
   build:
@@ -30,11 +27,11 @@ jobs:
           path: |
             ~/.cargo/registry
             ~/.cargo/git
-            ./target
-          key: ${{ runner.os }}-rust-${{ hashFiles('Cargo.toml') }}
+            ./api/target
+          key: ${{ runner.os }}-rust-${{ hashFiles('api/Cargo.toml') }}
 
       - name: Build
-        run: cargo build
+        run: cd api && cargo build
 
   clippy_lint:
     name: Lint
@@ -59,11 +56,11 @@ jobs:
           path: |
             ~/.cargo/registry
             ~/.cargo/git
-            ./target
-          key: ${{ runner.os }}-rust-lint-${{ hashFiles('Cargo.toml') }}
+            ./api/target
+          key: ${{ runner.os }}-rust-lint-${{ hashFiles('api/Cargo.toml') }}
 
       - name: Rustfmt
-        run: cargo fmt --all -- --check
+        run: cd api && cargo fmt --all -- --check
 
       - name: Clippy
-        run: cargo clippy
+        run: cd api && cargo clippy
diff --git a/.github/workflows/web-check.yaml b/.github/workflows/web-check.yaml
@@ -0,0 +1,32 @@
+name: 'Web Build'
+
+on:
+  push:
+    paths:
+      - '.github/workflows/web-check.yaml'
+      - 'web/**'
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Node.js Setup
+        uses: actions/setup-node@v3
+        with:
+          node-version: '20.x'
+
+      - name: NPM Dependencies
+        run: cd web && npm ci
+
+      - name: NPM Cache
+        uses: actions/cache@v2
+        with:
+          path: ./node_modules
+          key: ${{ runner.os }}-node-${{ hashFiles('web/package.json') }}
+
+      - name: Build app
+        run: cd web && npm run build
diff --git a/.github/workflows/deploy.yaml → .github/workflows/web-deploy.yaml b/.github/workflows/deploy.yaml → .github/workflows/web-deploy.yaml
@@ -31,10 +31,21 @@ jobs:
       - name: Setup Pages
         uses: actions/configure-pages@v3
 
+      - name: Node.js Setup
+        uses: actions/setup-node@v3
+        with:
+          node-version: '20.x'
+
+      - name: NPM Dependencies
+        run: cd web && npm ci
+
+      - name: Build app
+        run: cd web && npm run build
+
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v2
         with:
-          path: web
+          path: web/dist
 
       - name: Deploy to GitHub Pages
         id: deployment

diff --git a/README.md b/README.md
@@ -4,23 +4,9 @@ A service which stores information regarding authorship (attribution) of SCP Wik
 
 Because Wikidot does not recognize authorship beyond page creation, this has been a longstanding issue that SCP Wiki branches and sister sites have solved through the use of [attribution-metadata](https://scpwiki.com/attribution-metadata). This was previously a page on the Wikidot site which simply had a table with all the data on it, stored in wikitext. However, this means it is also subject to Wikidot page limitations, and when we passed that limit, it was clear that spending the time on a proper, better solution was the way to go.
 
-This is that service. It stores all the attribution data in AWS DynamoDB, and handles requests without a permanent server using AWS Lambda.
+This is that service. Defined in `api/`, this process stores all the attribution data in AWS DynamoDB, and handles requests without a permanent server using AWS Lambda.
 
-### Deployment
-
-Locally, you can verify that your code builds in the usual way:
-```
-cargo check
-```
-
-The most convenient way to produce artifacts that can be deployed to Lambda is using the [AWS Lambda Rust Runtime](https://github.com/awslabs/aws-lambda-rust-runtime). Using the `cargo lambda` subcommand:
-```
-cargo lambda build --release --arm64 --output-format zip
-```
-
-We target the ARM architecture because we are not using anything specific to x64, and ARM is cheaper and generally more power-efficient.
-
-The resultant ZIP file (found in `target/lambda/attribution-metadata`) can be uploaded to Lambda via the [console](https://us-east-2.console.aws.amazon.com/lambda/home?region=us-east-2#/functions/AttributionMetadataService).
+There is a corresponding web frontend, located in `web/`, which provides a convenient way of interacting with this service. However, any REST client can communicate with this service, for instance as part of automated checks or updates.
 
 ### License
 

diff --git a/Cargo.lock → api/Cargo.lock b/Cargo.lock → api/Cargo.lock
diff --git a/Cargo.toml → api/Cargo.toml b/Cargo.toml → api/Cargo.toml
diff --git a/api/README.md b/api/README.md
@@ -0,0 +1,19 @@
+## attribution-metadata API
+
+This is the backend Lambda service which serves attribution-metadata requests, reading and writing the data from DynamoDB.
+
+### Deployment
+
+Locally, you can verify that your code builds in the usual way:
+```
+cargo check
+```
+
+The most convenient way to produce artifacts that can be deployed to Lambda is using the [AWS Lambda Rust Runtime](https://github.com/awslabs/aws-lambda-rust-runtime). Using the `cargo lambda` subcommand:
+```
+cargo lambda build --release --arm64 --output-format zip
+```
+
+We target the ARM architecture because we are not using anything specific to x64, and ARM is cheaper and generally more power-efficient.
+
+The resultant ZIP file (found in `target/lambda/attribution-metadata`) can be uploaded to Lambda via the [console](https://us-east-2.console.aws.amazon.com/lambda/home?region=us-east-2#/functions/AttributionMetadataService).
diff --git a/build.rs → api/build.rs b/build.rs → api/build.rs
diff --git a/misc/header.txt → api/misc/header.txt b/misc/header.txt → api/misc/header.txt
diff --git a/src/attribution.rs → api/src/attribution.rs b/src/attribution.rs → api/src/attribution.rs
diff --git a/src/handlers.rs → api/src/handlers.rs b/src/handlers.rs → api/src/handlers.rs
diff --git a/src/macros.rs → api/src/macros.rs b/src/macros.rs → api/src/macros.rs
diff --git a/src/main.rs → api/src/main.rs b/src/main.rs → api/src/main.rs
diff --git a/src/object.rs → api/src/object.rs b/src/object.rs → api/src/object.rs
diff --git a/src/password.rs → api/src/password.rs b/src/password.rs → api/src/password.rs
diff --git a/src/result.rs → api/src/result.rs b/src/result.rs → api/src/result.rs
diff --git a/src/utils.rs → api/src/utils.rs b/src/utils.rs → api/src/utils.rs
diff --git a/web/LICENSE.md b/web/LICENSE.md
diff --git a/web/README.md b/web/README.md
@@ -1,7 +1,11 @@
-## attribution-metadata web
+## attribution-metadata Web
 
 This is a web UI for interfacing with the `attribution-metadata` Lambda service. It enables users to interact with the API in a user-friendly way, via their browser.
 
+### Internationalization
+
+This application supports translating into other languages. Simply add a corresponding list of translation strings within the `TRANSLATIONS` block in `src/util/i18n.ts`, connected with the language code. Then, on load, specifying the language code results in that language being loaded in the UI.
+
 ### Deployment
 
 First, ensure dependencies are up-to-date:
@@ -21,10 +25,6 @@ npm run build
 
 You can also use `bun` for these steps instead of `npm`.
 
-### License
-
-Available under the terms of the MIT License.
-
 ### Special Thanks
 
 Thanks to smlt for contributing the initial version of this web frontend.