set up github page

tira-io · Feb 4, 2024 · 5d22d44 · 5d22d44
commit 5d22d44
Show file tree

Hide file tree

Showing 27 changed files with 15,868 additions and 0 deletions.
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
@@ -0,0 +1,53 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      - name: Compile Javascript assets
+        run: |
+          cd browser
+          make
+          mv ./static/dist/index.html static/index.html
+          mv ./ui/*.jsonl static/
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload entire repository
+          path: './static'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
diff --git a/browser/.browserslistrc b/browser/.browserslistrc
@@ -0,0 +1,4 @@
+> 1%
+last 2 versions
+not dead
+not ie 11
diff --git a/browser/.devcontainer.json b/browser/.devcontainer.json
@@ -0,0 +1,8 @@
+{
+  "image": "mam10eks/github-page-tutorial:0.0.2",
+  "customizations": {
+    "vscode": {
+      "extensions": ["ms-python.python", "ms-python.vscode-pylance", "ms-toolsai.jupyter"]
+    }
+  }
+}
diff --git a/browser/.editorconfig b/browser/.editorconfig
@@ -0,0 +1,5 @@
+[*.{js,jsx,ts,tsx,vue}]
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+insert_final_newline = true
diff --git a/browser/.eslintrc.js b/browser/.eslintrc.js
@@ -0,0 +1,14 @@
+module.exports = {
+  root: true,
+  env: {
+    node: true,
+  },
+  extends: [
+    'plugin:vue/vue3-essential',
+    'eslint:recommended',
+    '@vue/eslint-config-typescript',
+  ],
+  rules: {
+    'vue/multi-word-component-names': 'off',
+  },
+}
diff --git a/browser/.gitignore b/browser/.gitignore
@@ -0,0 +1,23 @@
+.DS_Store
+node_modules
+/dist
+/static
+
+# local env files
+.env.local
+.env.*.local
+
+# Log files
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+# Editor directories and files
+.idea
+.vscode
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
diff --git a/browser/Makefile b/browser/Makefile
@@ -0,0 +1,6 @@
+build-ui-docker:
+	docker run --rm -v ${PWD}:/app -v ${PWD}/static/dist/:/dist -w /app --entrypoint vite mam10eks/github-page-tutorial:0.0.2 build
+
+coverage:
+	 pytest --cov=construct_indices \
+	 && coverage-badge -o construct_indices/coverage.svg
diff --git a/browser/README.md b/browser/README.md
@@ -0,0 +1,18 @@
+# base
+
+## Project setup
+
+We use a dev-container. In the dev container, compile everthing via 
+
+```
+vite dev
+```
+
+### Compilation
+
+```
+```
+
+### Customize configuration
+
+See [Configuration Reference](https://vitejs.dev/config/).
diff --git a/browser/index.html b/browser/index.html
@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+  <meta charset="UTF-8" />
+  <link rel="icon" href="/favicon.ico" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+</head>
+
+<body>
+  <div id="app"></div>
+  <script type="module" src="/src/main.ts"></script>
+</body>
+
+</html>
diff --git a/browser/jest.config.js b/browser/jest.config.js
@@ -0,0 +1,10 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'jsdom',
+  transform: {
+    '^.+\\.(ts|tsx|jsx)?$': 'ts-jest',
+    "^.+\\.(js|jsx)$": "babel-jest",
+  },
+  "coverageReporters": ["json-summary", "text", "lcov"],
+  "collectCoverageFrom" : ["src/ir_datasets.ts", "src/utils.ts", "src/main.ts"],
+};