inventree · SchrodingersGat · Sep 30, 2024 · Sep 30, 2024 · Sep 30, 2024 · Sep 30, 2024
diff --git a/.github/workflows/frontend.yaml b/.github/workflows/frontend.yaml
@@ -0,0 +1,21 @@
+# Run CI checks for frontend code
+name: Frontend CI
+
+on: ["push", "pull_request"]
+
+jobs:
+  frontend:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v2
+      - name: Install Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: "18"
+      - name: Build Frontend
+        run: |
+          cd frontend
+          npm install
+          npm run build --emptyOutDir
diff --git a/.github/workflows/pypi.yaml b/.github/workflows/pypi.yaml
@@ -19,15 +19,24 @@ jobs:
         uses: actions/setup-python@v2
         with:
           python-version: 3.7
+      - name: Install Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: "18"
       - name: Install Python Dependencies
         run: |
           pip install --upgrade wheel setuptools twine
+      - name: Build Frontend
+        run: |
+          cd frontend
+          npm install
+          npm run build --emptyOutDir
       - name: Build Binary
         run: |
-          python3 setup.py sdist bdist_wheel --universal
+          python -m build
       - name: Publish
         run: |
-          python3 -m twine upload dist/*
+          python -m twine upload dist/*
         env:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}

diff --git a/.gitignore b/.gitignore
@@ -102,3 +102,5 @@ celerybeat.pid
 # SageMath parsed files
 *.sage.py
 
+# Compiled static files (copied from frontend/dist/static as part of setup.py)
+inventree_wireviz/static
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1 +1,2 @@
-recursive-include inventree_wireviz/templates *
+recursive-include inventree_wireviz/templates *.js *.html
+recursive-include inventree_wireviz/static *.js *.css
diff --git a/frontend/.gitignore b/frontend/.gitignore
@@ -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
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+*.tsbuildinfo
diff --git a/frontend/README.md b/frontend/README.md
@@ -0,0 +1,31 @@
+# Wireviz Plugin - Frontend Code
+
+This directory contains the frontend code for the Wireviz plugin.
+
+## Development
+
+This project uses [Vite](https://vitejs.dev/) as the build tool. We followed [this guide](https://vitejs.dev/guide/#scaffolding-your-first-vite-project) to scaffold the project.
+
+## Building
+
+To compile the frontend code, run:
+
+```bash
+npm run build --emptyOutDir
+```
+
+This will compile the frontend code into the `../inventree_wireviz/static` directory.
+
+Note: The target directory is intentionally outside of hte frontend directory, so that the compiled files are correctly bundled into the python package install.
+
+## Testing
+
+To test the frontend code, run:
+
+```bash
+npm run dev
+```
+
+This will start a development server (usually on `localhost:5173`) which will automatically reload when changes are made to the source code.
+
+The development server provides some "dummy" harness data to test the frontend code.
diff --git a/frontend/eslint.config.js b/frontend/eslint.config.js
@@ -0,0 +1,28 @@
+import js from '@eslint/js'
+import globals from 'globals'
+import reactHooks from 'eslint-plugin-react-hooks'
+import reactRefresh from 'eslint-plugin-react-refresh'
+import tseslint from 'typescript-eslint'
+
+export default tseslint.config(
+  { ignores: ['dist'] },
+  {
+    extends: [js.configs.recommended, ...tseslint.configs.recommended],
+    files: ['**/*.{ts,tsx}'],
+    languageOptions: {
+      ecmaVersion: 2020,
+      globals: globals.browser,
+    },
+    plugins: {
+      'react-hooks': reactHooks,
+      'react-refresh': reactRefresh,
+    },
+    rules: {
+      ...reactHooks.configs.recommended.rules,
+      'react-refresh/only-export-components': [
+        'warn',
+        { allowConstantExport: true },
+      ],
+    },
+  },
+)
diff --git a/frontend/index.html b/frontend/index.html
@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>InvenTree Wireviz - Developer View</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>