Add frontend code

inventree · Nov 6, 2024 · 2118e4a · 2118e4a
1 parent 618036b
commit 2118e4a
Show file tree

Hide file tree

Showing 20 changed files with 6,011 additions and 0 deletions.
diff --git a/frontend/.gitignore b/frontend/.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/frontend/.vite/deps/_metadata.json b/frontend/.vite/deps/_metadata.json
@@ -0,0 +1,8 @@
+{
+  "hash": "d10362e3",
+  "configHash": "408b34e5",
+  "lockfileHash": "e3b0c442",
+  "browserHash": "e1cca9d1",
+  "optimized": {},
+  "chunks": {}
+}
diff --git a/frontend/.vite/deps/package.json b/frontend/.vite/deps/package.json
@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}
diff --git a/frontend/README.md b/frontend/README.md
@@ -0,0 +1,44 @@
+# InvenTree Stock Scheduling - Frontend Code
+
+This directory contains the frontend code for the InvenTree Stock Scheduling plugin.
+
+## Architecture
+
+The frontend code is designed to integrate natively with the InvenTree user interface.
+
+### Frameworks
+
+We use Mantine, running on React, to match the InvenTree stack.
+
+- [React](https://react.dev/)
+- [Mantine](https://mantine.dev/)
+
+### Project Setup
+
+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
+
+*Note: Assumed you are already in the `frontend` directory.*
+
+To compile the frontend code, run:
+
+```bash
+npm run build --emptyOutDir
+```
+
+This will compile the frontend into the `../order_history/static` directory (ready for distribution).
+
+Note: The target directory is intentionally outside of the 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 Scheduling</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>