refactor: move parcel dashboard to /apps

.eslintrc

@@ -117,7 +117,7 @@
       }
     },
     {
-      "files": "test/playwright/**",
+      "files": "apps/dashboard-parcel/test/playwright/**",
       "extends": "plugin:playwright/recommended"
     },
     {

README-lib.md

@@ -1,4 +1,4 @@
-# VEDA Dashboard
+# VEDA Dashboard - Component Library
 
 ![VEDA logo](./docs/media/nasa-veda-logo-pos.svg)
 

apps/dashboard-parcel/README.md

@@ -0,0 +1,30 @@
+# VEDA Dashboard
+
+![VEDA logo](../../docs/media/nasa-veda-logo-pos.svg)
+
+VEDA is a dashboard to explore data.
+
+This repository contains the UI component of VEDA where development of new features happens.
+If you're looking to add content check the [veda-config](https://github.com/NASA-IMPACT/veda-config) repository.
+
+## Content documentation
+
+**⚠️ The content configuration should not happen on this repository, but on your instance of [veda-config](https://github.com/NASA-IMPACT/veda-config).**
+
+The following documentation will guide you through the process of configuring the content.
+
+- Check [CONFIGURATION](../../docs/content/CONFIGURATION.md) to see a list of configuration options for VEDA.
+- Check [CONTENT](../../docs/content/CONTENT.md) for how to structure the content pieces.
+- Check [PAGE_OVERRIDES](../../docs/content/PAGE_OVERRIDES.md) for all the layout overrides available to you and how they work.
+
+
+## Development documentation
+
+Check the documentation below for how to setup and develop features for `veda-ui`.
+
+- **Start here**: Check [SETUP.md](../../docs/development/SETUP.md) for instructions on how to set up your local development environment.
+- Check [ARCHITECTURE](../../docs/development/ARCHITECTURE.md) docs to read about architecture.
+- Check [PAGE_OVERRIDES](../../docs/development/PAGE_OVERRIDES.md) for information about the component/content overriding feature.
+
+## License
+This project is licensed under **Apache 2**, see the [LICENSE](../../LICENSE) file for more details.

app/index.html → apps/dashboard-parcel/index.html

@@ -134,7 +134,7 @@ <h1>{{appTitle}}</h1>
     }
   </script>
 
-  <script type='module' src='../packages/veda-ui/src/main.tsx'></script>
+  <script type='module' src='../../packages/veda-ui/src/main.tsx'></script>
 </body>
 
 </html>

test/playwright/tests/stories.spec.ts → apps/dashboard-parcel/test/playwright/tests/stories.spec.ts

@@ -2,7 +2,7 @@ import { test, expect } from '../pages/basePage';
 
 const stories = JSON.parse(
   // eslint-disable-next-line @typescript-eslint/no-require-imports
-  require('fs').readFileSync('test/playwright/playwrightTestData.json', 'utf8')
+  require('fs').readFileSync('apps/dashboard-parcel/test/playwright/playwrightTestData.json', 'utf8')
 )['stories'];
 
 test('load stories on /stories route', async ({

test/playwright/tests/storiesRouting.spec.ts → apps/dashboard-parcel/test/playwright/tests/storiesRouting.spec.ts

@@ -2,7 +2,7 @@ import { test, expect } from '../pages/basePage';
 
 const stories = JSON.parse(
   // eslint-disable-next-line @typescript-eslint/no-require-imports
-  require('fs').readFileSync('test/playwright/playwrightTestData.json', 'utf8')
+  require('fs').readFileSync('apps/dashboard-parcel/test/playwright/playwrightTestData.json', 'utf8')
 )['stories'];
 
 test.describe('stories card routing', () => {

docs/development/DEPLOYMENT.md

@@ -20,5 +20,5 @@ The app can then be run by any web server.
 If you want to use any other parcel feature it is also possible. Example:
 
 ```
-PARCEL_BUNDLE_ANALYZER=true yarn parcel build app/index.html
+PARCEL_BUNDLE_ANALYZER=true yarn parcel build apps/dashboard-parcel/index.html
 ```

gulpfile.js

@@ -110,7 +110,8 @@ function parcelBuildLib(cb) {
 // package.json to use. When running this directly from the UI repo (for
 // development) we need to actively point parcel to the correct target
 // otherwise the site doesn't get built.
-const parcelTarget = process.cwd() === __dirname ? ['app/index.html'] : [];
+const parcelTarget =
+  process.cwd() === __dirname ? ['apps/dashboard-parcel/index.html'] : [];
 
 function parcelServe(cb) {
   portscanner.findAPortNotInUse(9000, 9999, function (error, port) {

jest.config.js

@@ -211,5 +211,5 @@ module.exports = {
   // Whether to use watchman for file crawling
   // watchman: true,
 
-  modulePathIgnorePatterns: ['/test/playwright/']
+  modulePathIgnorePatterns: ['/apps/dashboard-parcel/test/playwright/']
 };

package.json

@@ -31,7 +31,7 @@
     "lint:css": "stylelint 'packages/veda-ui/src/styles/**/**' 'packages/veda-ui/src/**/*.(js|ts|tsx|jsx)'",
     "ts-check": "yarn tsc --noEmit --skipLibCheck",
     "test": "TZ=UTC jest",
-    "pretest:e2e": "node test/playwright/generateTestData.js",
+    "pretest:e2e": "node apps/dashboard-parcel/test/playwright/generateTestData.js",
     "test:e2e": "yarn playwright test",
     "test:e2e:ui": "yarn playwright test --ui",
     "release": "release-it --",
@@ -41,7 +41,7 @@
   },
   "targets": {
     "veda-app": {
-      "source": "./app/index.html",
+      "source": "./apps/dashboard-parcel/index.html",
       "context": "browser"
     }
   },
@@ -269,7 +269,7 @@
     "$uswds": "~/packages/veda-ui/src/uswds",
     "$libs": "~/packages/veda-ui/src/libs",
     "$graphics": "~/packages/veda-ui/graphics",
-    "$test": "~/test",
+    "$test": "~/apps/dashboard-parcel/test",
     "$mock": "~/mock",
     "$static": "~/static"
   },

packages/veda-ui/src/components/common/page-footer/footer.test.tsx

@@ -5,7 +5,7 @@ import NasaLogoColor from '../nasa-logo-color';
 import { NavItem } from '../page-header/types.js';
 
 import PageFooter from './index';
-import { VedaUIConfigProvider } from '$test/utils.js';
+import { VedaUIConfigProvider } from '$test/utils';
 import { navItems } from '$mock/veda.config.js';
 
 const defaultFooterSetting = {

packages/veda-ui/src/components/common/page-header/page-header.test.tsx

@@ -6,7 +6,7 @@ import { BrowserRouter } from 'react-router-dom';
 import NasaLogoColor from '../nasa-logo-color';
 import { NavItem } from './types';
 import PageHeader from './index';
-import { VedaUIConfigProvider } from '$test/utils.js';
+import { VedaUIConfigProvider } from '$test/utils';
 import { navItems } from '$mock/veda.config.js';
 
 // @NOTE: Possible Test cases

playwright.config.ts

@@ -1,7 +1,11 @@
 import { defineConfig, devices } from '@playwright/test';
 
+/**
+ * E2E Tests for the Dashboard Application (apps/dashboard-parcel)
+ */
 export default defineConfig({
-  testDir: './test',
+  testDir: './apps/dashboard-parcel/test/playwright/tests',
+  testMatch: '**/*.spec.ts',
   fullyParallel: true,
   forbidOnly: !!process.env.CI,
   retries: process.env.CI ? 2 : 0,

tsconfig.json

@@ -17,7 +17,7 @@
       "$data-layer/*": ["packages/veda-ui/src/data-layer/*"],
       "$uswds": ["packages/veda-ui/src/uswds/"],
       "$graphics/*": ["packages/veda-ui/graphics/*"],
-      "$test/*": ["test/*"],
+      "$test/*": ["apps/dashboard-parcel/test/*"],
       "$mock/*": ["mock/*"],
       "$storybook": ["storybook/*"]
     }