chore: update to v5.0.0 alpha.2.15 (#17)

* chore: update readme

* feat: added a hidden widget example with comments

* chore: update dependencies and format

* chore: update to v2.5 and remove svelte zoom-btn

* feat: add vanillaJs reset zoom example

* feat: add custom font + add explanatory comments

* fix: setup node v20 in actions

* fix: selection

* chore: update eodash to v5.0.0-alpha.2.6

* update to `v5.0.0-alpha.2.12`

* chore: updated eodash dependency and configuration example accordingly

* chore: fix list overflow

* update main.js to use default config

---------

Co-authored-by: Daniel Santillan <[email protected]>

.github/workflows/deploy.yml

@@ -12,13 +12,21 @@ jobs:
       pages: write
       pull-requests: write
     steps:
-      - uses: actions/checkout@v3
-      - run: |
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup node env
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          check-latest: true
+      - name: Checkout
+        run: |
           npm install
           npm run build -- --base /${{ github.event.repository.name }}/
           cp .eodash/dist/index.html .eodash/dist/404.html
           touch .eodash/dist/.nojekyll
-      - uses: JamesIves/github-pages-deploy-action@v4
+      - name: Deploy
+        uses: JamesIves/github-pages-deploy-action@v4
         with:
           folder: ./.eodash/dist/
           branch: gh-pages

.github/workflows/preview.yml

@@ -21,7 +21,11 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v3
-
+      - name: Setup node env
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          check-latest: true
       - name: Install and Build
         if: github.event.action != 'closed'
         run: |

.gitignore

@@ -1,5 +1,4 @@
 node_modules
-app
 .vscode
 .DS_Store
 .eodash/

README.md

@@ -1,15 +1,61 @@
 # eodash Configuration and Deployment Template
 
-This is a template repository for configuring and deploying [eodash](https://github.com/eodash/eodash)
+This is an instance template for [@eodash/eodash](https://github.com/eodash/eodash). Check Github's guide on [how to create a repository from a template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)
 
 ## Prerequisites
 
-- Node v18 or higher
+- Node v20.15.1 or higher
 
-## Static Assets
+## Get Started
 
-files and directories inside the `public` directory will be served statically in the application. They can be refrenced inside the config using their relative path:
+Install all the required dependecies:
 
-```js
-new URL("/directory/file", import.meta.url).href;
+```bash
+npm run install
 ```
+
+Run the dev server:
+
+```bash
+npm run dev
+```
+
+To compile and minify for production:
+
+```bash
+npm run build
+```
+
+To preview the compiled production files :
+
+```bash
+npm run preview
+```
+
+To compile and minify as a web component library:
+
+```bash
+npm run build -- --lib
+```
+
+Format using prettier:
+
+```bash
+npm run format
+```
+
+Run linter:
+
+```bash
+npm run lint
+```
+
+## Folder Structure
+
+    .
+    ├── public            # statically served files
+    ├── src               # Client source code that hosts the microfrontends and renders the dashboard
+    │    ├── widgets      # Contains custom defined internal widgets
+    │    └─  main.js      # eodash main entry point
+    │
+    └── README.md

eodash.config.js

@@ -1,16 +1,7 @@
-/** @type {import("@eodash/eodash").EodashCLiConfig} */
-export default {
-  base: "",
+import { defineConfig } from "@eodash/eodash/config";
+
+export default defineConfig({
   dev: {
-    port: 3001,
-    host: false,
-    open: false,
+    port: 3000,
   },
-  preview: {
-    port: 4173,
-    host: true,
-    open: true,
-  },
-  outDir: ".eodash/dist",
-  cacheDir: ".eodash/temp",
-};
+});

eslint.config.js

@@ -0,0 +1,10 @@
+import pluginVue from "eslint-plugin-vue";
+import eox from "@eox/eslint-config";
+
+export default [
+  ...eox,
+  ...pluginVue.configs["flat/essential"],
+  {
+    ignores: ["public/", ".eodash/"],
+  },
+];