add hightable-demo (#39)

* move the app to apps/cli/ * fix ci * try to fix the CI * add hightable-demo * clearer titles * add missing favicon and update README also: use eslint configuration recommended by vite
hyparam · Nov 12, 2024 · 19b8103 · 19b8103
1 parent 3b159f3
commit 19b8103
Show file tree

Hide file tree

Showing 19 changed files with 541 additions and 4 deletions.
diff --git a/.github/workflows/ci_cli.yml → .github/workflows/ci_apps_cli.yml b/.github/workflows/ci_cli.yml → .github/workflows/ci_apps_cli.yml
@@ -1,10 +1,10 @@
-name: CI in the cli app
+name: apps/cli
 on:
   push:
     paths:
       - 'packages/components/**'
       - 'apps/cli/**'
-      - '.github/workflows/ci_cli.yml'
+      - '.github/workflows/ci_apps_cli.yml'
 
 defaults:
   run:

diff --git a/.github/workflows/ci_apps_hightable_demo.yml b/.github/workflows/ci_apps_hightable_demo.yml
@@ -0,0 +1,32 @@
+name: apps/hightable-demo
+on:
+  push:
+    paths:
+      - 'apps/hightable-demo/**'
+      - '.github/workflows/ci_apps_hightable_demo.yml'
+
+defaults:
+  run:
+    working-directory: ./apps/hightable-demo
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: npm i
+      - run: npm run lint
+
+  typecheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: npm i
+      - run: tsc
+
+  buildcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: npm i
+      - run: npm run build
diff --git a/.github/workflows/ci_components.yml → .github/workflows/ci_packages_components.yml b/.github/workflows/ci_components.yml → .github/workflows/ci_packages_components.yml
@@ -1,9 +1,9 @@
-name: CI in the components package
+name: packages/components
 on:
   push:
     paths:
       - 'packages/components/**'
-      - '.github/workflows/ci_components.yml'
+      - '.github/workflows/ci_packages_components.yml'
 
 defaults:
   run:

diff --git a/apps/hightable-demo/.gitignore b/apps/hightable-demo/.gitignore
@@ -0,0 +1,24 @@
+# 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
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
diff --git a/apps/hightable-demo/README.md b/apps/hightable-demo/README.md
@@ -0,0 +1,18 @@
+# HighTable demo
+
+This is an example project showing how to use [hightable](https://github.com/hyparam/hightable).
+
+## Build
+
+```bash
+cd apps/hightable-demo
+npm i
+npm run build
+```
+
+The build artifacts will be stored in the `dist/` directory and can be served using any static server, eg. `http-server`:
+
+```bash
+npm i -g http-server
+http-server dist/
+```
diff --git a/apps/hightable-demo/eslint.config.js b/apps/hightable-demo/eslint.config.js
@@ -0,0 +1,40 @@
+import js from '@eslint/js'
+import react from 'eslint-plugin-react'
+import reactHooks from 'eslint-plugin-react-hooks'
+import reactRefresh from 'eslint-plugin-react-refresh'
+import globals from 'globals'
+import tseslint from 'typescript-eslint'
+
+export default tseslint.config(
+  { ignores: ['dist'] },
+  {
+    extends: [js.configs.recommended, ...tseslint.configs.strictTypeChecked, ...tseslint.configs.stylisticTypeChecked],
+    // Set the react version
+    settings: { react: { version: '18.3' } },
+    files: ['src/**/*.{ts,tsx}'],
+    languageOptions: {
+      ecmaVersion: 2020,
+      globals: globals.browser,
+      parserOptions: {
+        project: './tsconfig.json',
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+    plugins: {
+      react,
+      'react-hooks': reactHooks,
+      'react-refresh': reactRefresh,
+    },
+    rules: {
+      ...reactHooks.configs.recommended.rules,
+      'react-refresh/only-export-components': [
+        'warn',
+        { allowConstantExport: true },
+      ],
+      ...react.configs.recommended.rules,
+      ...react.configs['jsx-runtime'].rules,
+
+      '@typescript-eslint/restrict-template-expressions': 'off',
+    },
+  },
+)
diff --git a/apps/hightable-demo/index.html b/apps/hightable-demo/index.html
@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>HighTable Viewer Demo</title>
+  <link rel="icon" type="image/svg+xml" href="favicon.png" />
+  <link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Mulish:wght@300;600&display=swap"/>
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+</head>
+<body>
+  <nav>
+    <a class="brand" href='https://hyparam.github.io/hightable/'>
+      HighTable
+    </a>
+  </nav>
+  <div id="app"></div>
+  <script type="module" src="/src/main.tsx"></script>
+</body>
+</html>
diff --git a/apps/hightable-demo/package.json b/apps/hightable-demo/package.json
@@ -0,0 +1,31 @@
+{
+  "name": "hightable-demo",
+  "private": true,
+  "version": "0.0.0",
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc -b && vite build",
+    "lint": "eslint .",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "hightable": "0.7.0",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.13.0",
+    "@types/react": "^18.3.12",
+    "@types/react-dom": "^18.3.1",
+    "@vitejs/plugin-react": "^4.3.3",
+    "eslint": "^9.13.0",
+    "eslint-plugin-react": "^7.37.2",
+    "eslint-plugin-react-hooks": "^5.0.0",
+    "eslint-plugin-react-refresh": "^0.4.14",
+    "globals": "^15.11.0",
+    "typescript": "~5.6.2",
+    "typescript-eslint": "^8.11.0",
+    "vite": "^5.4.10"
+  }
+}
diff --git a/apps/hightable-demo/public/favicon.png b/apps/hightable-demo/public/favicon.png