Init app

.github/workflows/labeler.yml

@@ -1,6 +1,7 @@
 name: "Pull Request Labeler"
+
 on:
-- pull_request_target
+ - pull_request_target
 
 jobs:
  labeler:
@@ -9,4 +10,4 @@ jobs:
  pull-requests: write
  runs-on: ubuntu-latest
  steps:
- - uses: actions/labeler@v5
+  - uses: actions/labeler@v5

.github/workflows/test-app.yml

@@ -0,0 +1,113 @@
+name: Test app
+
+on:
+ pull_request:
+ paths:
+ - "app/**"
+
+env:
+ CACHE_PATH: |
+ app/node_modules
+
+defaults:
+ run:
+ working-directory: ./app
+
+jobs:
+ # build cache for rest of jobs
+ install-cache:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v4
+
+ - name: Set up Bun
+ uses: oven-sh/setup-bun@v1
+
+ - if: runner.debug == '1'
+ uses: mxschmitt/action-tmate@v3
+
+ - name: Install packages
+ run: bun install
+
+ - name: Define cache key
+ id: define-key
+ run: echo "key=${{ hashFiles('app/bun.lockb') }}" >> $GITHUB_OUTPUT
+
+ - name: Store cache
+ uses: actions/cache@v4
+ with:
+ path: ${{ env.CACHE_PATH }}
+ key: ${{ steps.define-key.outputs.key }}
+
+ outputs:
+ cache-key: ${{ steps.define-key.outputs.key }}
+
+ # test that app can build without issues
+ test-build:
+ runs-on: ubuntu-latest
+ needs: install-cache
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v4
+
+ - name: Set up Bun
+ uses: oven-sh/setup-bun@v1
+
+ - name: Restore cache
+ uses: actions/cache@v4
+ with:
+ path: ${{ env.CACHE_PATH }}
+ key: ${{ needs.install-cache.outputs.cache-key }}
+
+ - if: runner.debug == '1'
+ uses: mxschmitt/action-tmate@v3
+
+ - name: Run test
+ run: bun run build
+
+ # test that app has no typescript errors
+ test-types:
+ runs-on: ubuntu-latest
+ needs: install-cache
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v4
+
+ - name: Set up Bun
+ uses: oven-sh/setup-bun@v1
+
+ - name: Restore cache
+ uses: actions/cache@v4
+ with:
+ path: ${{ env.CACHE_PATH }}
+ key: ${{ needs.install-cache.outputs.cache-key }}
+
+ - if: runner.debug == '1'
+ uses: mxschmitt/action-tmate@v3
+
+ - name: Run test
+ run: bun run test:types
+
+ # test that app is properly formatted and linted
+ test-lint:
+ runs-on: ubuntu-latest
+ needs: install-cache
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v4
+
+ - name: Set up Bun
+ uses: oven-sh/setup-bun@v1
+
+ - name: Restore cache
+ uses: actions/cache@v4
+ with:
+ path: ${{ env.CACHE_PATH }}
+ key: ${{ needs.install-cache.outputs.cache-key }}
+
+ - if: runner.debug == '1'
+ uses: mxschmitt/action-tmate@v3
+
+ - name: Run test
+ run: bun run test:lint

.github/workflows/update-data.yml

@@ -0,0 +1,33 @@
+name: Update app data
+
+on:
+ pull_request:
+ workflow_dispatch:
+
+defaults:
+ run:
+ working-directory: ./app
+
+jobs:
+ update:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v4
+
+ - name: Set up Bun
+ uses: oven-sh/setup-bun@v1
+
+ - if: runner.debug == '1'
+ uses: mxschmitt/action-tmate@v3
+
+ - name: Install packages
+ run: bun install
+
+ - name: Run update
+ run: bun run update
+
+ - name: Commit updated data
+ uses: stefanzweifel/git-auto-commit-action@v5
+ with:
+ commit_message: "Update data"

app/.env

@@ -0,0 +1,3 @@
+VITE_TITLE=3Blue1Brown Translations
+VITE_DESCRIPTION=Community contributed translations for 3Blue1Brown content.
+VITE_URL=http://translation.3blue1brown.com/

app/.eslintignore

@@ -0,0 +1,25 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+!.vscode/settings.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

app/.eslintrc

@@ -0,0 +1,17 @@
+{
+ "root": true,
+ "env": { "browser": true, "es2020": true },
+ "extends": [
+ "eslint:recommended",
+ "plugin:@typescript-eslint/recommended",
+ "plugin:react-hooks/recommended",
+ "plugin:jsx-a11y/recommended"
+ ],
+ "ignorePatterns": ["dist"],
+ "parser": "@typescript-eslint/parser",
+ "plugins": ["react-refresh", "prettier"],
+ "rules": {
+ "prettier/prettier": "warn",
+ "@typescript-eslint/no-unused-vars": "warn"
+ }
+}

app/.gitignore

@@ -0,0 +1,3 @@
+node_modules
+dist
+.DS_Store

app/.prettierignore

@@ -0,0 +1,2 @@
+node_modules
+dist

app/.prettierrc

@@ -0,0 +1,16 @@
+{
+ "plugins": [
+ "@ianvs/prettier-plugin-sort-imports",
+ "prettier-plugin-css-order"
+ ],
+ "importOrder": [
+ "^react",
+ "^[a-zA-Z]",
+ "^@[a-zA-Z]",
+ "^@/",
+ "^/",
+ "^./",
+ "^../"
+ ],
+ "cssDeclarationSorterOrder": "smacss"
+}

app/README.md

@@ -0,0 +1,23 @@
+# Web app frontend
+
+This project was scaffolded using Vite, and has the following key features:
+
+- React 18
+- TypeScript, for static type checking
+- ESLint, for code quality
+- Prettier, for code formatting
+
+## Requirements
+
+- [Bun](https://bun.sh/)
+
+## Commands
+
+| Command | Description |
+| ----------------- | ------------------------------------------------- |
+| `bun install` | Install packages |
+| `bun run dev` | Start local dev server with hot-reloading |
+| `bun run build` | Build production version of app |
+| `bun run preview` | Serve built version of app (must run build first) |
+| `bun run lint` | Fix linting and formatting |
+| `bun run test` | Run tests |