Merge branch 'main' into time-alignment-ui

.gitignore

@@ -13,16 +13,14 @@ coverage
 # Ignore node_modules folder
 node_modules
 build/api
-pyflask/ds
-src/Users
+src/pyflask/ds
 semantic
 semantic.json
 .env
 build/
 yarn.lock
 
 *.pyc
-src/.DS_Store
 .DS_Store
 electron-builder.yml
 website/.eslintcache

.pre-commit-config.yaml

@@ -1,19 +1,23 @@
 repos:
+
 -   repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.6.0
     hooks:
     -   id: check-yaml
     -   id: end-of-file-fixer
     -   id: trailing-whitespace
+
 -   repo: https://github.com/psf/black
     rev: 24.4.2
     hooks:
     -   id: black
         exclude: ^docs/
+
 -   repo: https://github.com/PyCQA/isort
     rev: 5.13.2
     hooks:
     -   id: isort
+
 -   repo: https://github.com/pre-commit/mirrors-prettier
     rev: "v4.0.0-alpha.8"
     hooks:

.storybook/main.ts

@@ -3,7 +3,7 @@ import type { StorybookConfig } from '@storybook/web-components-vite';
 import ViteYaml from "@modyfi/vite-plugin-yaml";
 
 const config: StorybookConfig = {
-    stories: ["../src/**/*.mdx", "../src/**/*.stories.@(js|jsx|ts|tsx)"],
+    stories: ["../stories/**/*.mdx", "../stories/**/*.stories.@(js|jsx|ts|tsx)"],
     addons: ["@storybook/addon-links", "@storybook/addon-essentials"],
     framework: {
         name: "@storybook/web-components-vite",

.storybook/manager.js

@@ -1,26 +1,26 @@
-// .storybook/manager.js
-
-import { addons } from "@storybook/addons";
-
-addons.setConfig({
-    isFullscreen: false,
-    showNav: true,
-    showPanel: true,
-    panelPosition: "bottom",
-    enableShortcuts: false,
-    showToolbar: true,
-    theme: undefined,
-    selectedPanel: undefined,
-    initialActive: "sidebar",
-    sidebar: {
-        showRoots: false,
-        collapsedRoots: ["other"],
-    },
-    toolbar: {
-        title: { hidden: false },
-        zoom: { hidden: false },
-        eject: { hidden: false },
-        copy: { hidden: false },
-        fullscreen: { hidden: false },
-    },
-});
+// .storybook/manager.js
+
+import { addons } from "@storybook/addons";
+
+addons.setConfig({
+    isFullscreen: false,
+    showNav: true,
+    showPanel: true,
+    panelPosition: "bottom",
+    enableShortcuts: false,
+    showToolbar: true,
+    theme: undefined,
+    selectedPanel: undefined,
+    initialActive: "sidebar",
+    sidebar: {
+        showRoots: false,
+        collapsedRoots: ["other"],
+    },
+    toolbar: {
+        title: { hidden: false },
+        zoom: { hidden: false },
+        eject: { hidden: false },
+        copy: { hidden: false },
+        fullscreen: { hidden: false },
+    },
+});

.storybook/preview.js

@@ -1,18 +1,18 @@
-/** @type { import('@storybook/web-components').Preview } */
-const preview = {
-    parameters: {
-        chromatic: { disableSnapshot: true },
-        backgrounds: {
-            default: "light",
-        },
-        actions: { argTypesRegex: "^on[A-Z].*" },
-        controls: {
-            matchers: {
-                color: /(background|color)$/i,
-                date: /Date$/,
-            },
-        },
-    },
-};
-
-export default preview;
+/** @type { import('@storybook/web-components').Preview } */
+const preview = {
+    parameters: {
+        chromatic: { disableSnapshot: true },
+        backgrounds: {
+            default: "light",
+        },
+        actions: { argTypesRegex: "^on[A-Z].*" },
+        controls: {
+            matchers: {
+                color: /(background|color)$/i,
+                date: /Date$/,
+            },
+        },
+    },
+};
+
+export default preview;

README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <img src="src/renderer/assets/img/logo-guide-draft-transparent-tight.png" width="250" alt="NeuroConv logo"/>
+  <img src="src/electron/frontend/assets/img/logo-guide-draft-transparent-tight.png" width="250" alt="NeuroConv logo"/>
   <h3 align="center">NWB Graphical User Interface for Data Entry</h3>
   <p align="center">
     <a href="https://github.com/NeurodataWithoutBorders/nwb-guide/actions/workflows/testing.yml"><img src="https://github.com/NeurodataWithoutBorders/nwb-guide/actions/workflows/testing.yml/badge.svg" alt="Full Tests"></a>

docs/_static/css/custom.css

@@ -1,33 +1,33 @@
-/* Improve spacing */
-.version-switcher__container.dropdown {
-    margin-left: 10px;
-}
-
-button.btn.version-switcher__button {
-    margin-bottom: 0px;
-}
-
-/* Show on hover */
-.version-switcher__container.dropdown:hover .dropdown-menu {
-    display: block;
-    left: 0;
-    margin-top: var(--bs-dropdown-spacer);
-    top: 100%;
-}
-
-.dropdown-menu.show {
-    display: none;
-}
-
-/* Remove underline and borders */
-button.btn.version-switcher__button:hover {
-    text-decoration: none;
-}
-
-.version-switcher__menu a.list-group-item {
-    border: none !important;
-}
-
-.version-switcher__menu a.list-group-item:hover {
-    text-decoration: none !important;
-}
+/* Improve spacing */
+.version-switcher__container.dropdown {
+    margin-left: 10px;
+}
+
+button.btn.version-switcher__button {
+    margin-bottom: 0px;
+}
+
+/* Show on hover */
+.version-switcher__container.dropdown:hover .dropdown-menu {
+    display: block;
+    left: 0;
+    margin-top: var(--bs-dropdown-spacer);
+    top: 100%;
+}
+
+.dropdown-menu.show {
+    display: none;
+}
+
+/* Remove underline and borders */
+button.btn.version-switcher__button:hover {
+    text-decoration: none;
+}
+
+.version-switcher__menu a.list-group-item {
+    border: none !important;
+}
+
+.version-switcher__menu a.list-group-item:hover {
+    text-decoration: none !important;
+}

docs/developer_guide.rst

@@ -83,15 +83,24 @@ You can now run the following command to start the application using Electron.
 
 Repo Structure
 --------------
-1. **src/renderer/src** - Contains all the source code for the frontend
-    - `index.js` - The entry point for the application
-    - `pages.js` - The main code that controls which pages are rendered and how they are linked together
-    - `stories` - Contains all the Web Components and related Storybook stories
-    - `electron` - Contains all the Electron-related code to enable conditional inclusion for development mode
-2. **src/renderer/assets** - Contains all the frontend-facing assets (e.g. images, css, etc.)
-3. **pyflask** - Contains all the source code for the backend
-
-
+- `src`
+    - `electron`
+        - `main`
+            - `src` - Contains all the source code for the backend
+            - `assets` - Contains all the backend-facing assets (e.g. images, css, etc.)
+        - `preload`
+            - `preload.js` - Exposes electron-specific variables to the frontend
+        - `frontend`
+            - `core` - Contains all the source code for the frontend
+                - `index.js` - The entry point for the application
+                - `pages.js` - The main code that controls which pages are rendered and how they are linked together
+                - `components` - Contains all the UI Components used throughout the app
+            - `assets` - Contains all the frontend-facing assets (e.g. images, css, etc.)
+            - `utils`
+                - `electron.js` - Contains electron-exposed variables
+                - `url.js` - Saving the history state for hot reloading and refresh page functionality
+    - `pyflask` - Contains all the source code for the backend
+    - `schemas` - Contains all the JSON schemas used for validation
 
 
 Starting a New Feature

docs/index.rst

@@ -2,7 +2,7 @@ NWB GUIDE documentation
 =======================
 |
 
-.. image:: ../src/renderer/assets/img/logo-guide-draft-transparent-tight.png
+.. image:: ../src/electron/frontend/assets/img/logo-guide-draft-transparent-tight.png
   :scale: 50 %
   :align: center
   :alt: NWB GUIDE logo