Merge pull request #66 from bcdev/forman-57-split_lib_and_demo_3

Split lib and demo

Author: forman

.github/workflows/frontend-ci.yml

@@ -17,22 +17,32 @@ jobs:
         with:
           node-version: '18.x'
 
-      - name: Install dependencies
+      - name: Install common dependencies
         run: |
           cd chartlets.js 
           npm install 
 
-      - name: Linter
+      - name: Lib lint
         run: |
-          cd chartlets.js  
+          cd chartlets.js/packages/lib  
           npm run lint
 
-      - name: Run frontend tests
+      - name: Lib tests
         run: |
-          cd chartlets.js  
+          cd chartlets.js/packages/lib  
           npm run test
 
-      - name: Build frontend application
+      - name: Lib build
         run: |
-          cd chartlets.js  
+          cd chartlets.js/packages/lib  
+          npm run build
+
+      - name: Demo lint
+        run: |
+          cd chartlets.js/packages/demo  
+          npm run lint
+
+      - name: Demo build
+        run: |
+          cd chartlets.js/packages/demo  
           npm run build

.github/workflows/publish.yml

@@ -123,7 +123,11 @@ jobs:
           cache-dependency-path: chartlets.js/package-lock.json
 
       - run: npm ci
-      - run: npm run build
-      - run: npm publish --access public
+      - run: |
+          cd packages/lib
+          npm run build
+      - run: |
+          cd packages/lib
+          npm publish --access public
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

@@ -11,10 +11,11 @@ Please see the [Documentation](https://bcdev.github.io/chartlets/) for more info
 
 ## Features
 
-- Enhance your React web application by UI-contributions programmed in Python
-- Enhance your (Python) web API to serve server-side UI-contributions.
-- Uses [Material UI](https://mui.com/material-ui/) components and 
-  [Vega-Lite](https://vega.github.io/vega-lite/) charts.
+- Enhance your React web application by UI-contributions programmed in Python.
+- Enhance your Python REST server to publish server-side UI-contributions.
+- Support your favorite charting library or UI component library by plugins.
+- Use provided plugins for [Vega-Lite](https://vega.github.io/vega-lite/) charts and [Material UI](https://mui.com/material-ui/)
+  components.
 
 ## License
 

chartlets.js/.gitignore

@@ -7,7 +7,7 @@ yarn-error.log*
 pnpm-debug.log*
 lerna-debug.log*
 
-node_modules
+packages/lib/node_modules
 dist
 dist-ssr
 *.local

chartlets.js/CHANGES.md

@@ -1,3 +1,33 @@
+## Version 0.1.0 (in development)
+
+* Reorganised Chartlets project to better separate demo from library code.
+  Using monorepo layout for `chartlets.js` with workspaces `lib` and `demo`
+  that host the packages for `chartlets` and `chartlets-demo`.
+
+* Chartlets now allows for plugins that can provide individual component 
+  implementations.
+  The Vega-based chart and MUI components are now optional and have been 
+  moved into respective plugin modules `chartlets/plugins/vega` and
+  `chartlets/plugins/mui`.
+  To activate them, use the new `plugins: PluginLike[]` option 
+  of `FrameworkOptions`:
+  ```TypeScript
+  import { configureFramework } from "chartlets";
+  import mui from "chartlets/plugins/mui";
+  import vega from "chartlets/plugins/vega";
+  
+  configureFramework({ plugins: [mui(), vega()], ... });   
+  ```
+
+* Renamed `Plot` component into `VegaChart`.
+
+* The new `VegaChart` component respects a `theme` property. If not given,
+  it will respect the current theme mode `"dark"` otherwise fallback to the
+  Vega default theme. 
+
+* The demo application now allows for switching the theme mode between
+  dark, light, and system mode.
+
 ## Version 0.0.29 (from 2024/11/26)
 
 * Resolved warnings that appeared when using Vega charts.

chartlets.js/README.md

@@ -1,23 +1,14 @@
-# chartlets 
+# Chartlets 
 
-[![Frontend CI workflow](https://github.com/bcdev/chartlets/actions/workflows/frontend-ci.yml/badge.svg)](https://github.com/bcdev/chartlets/actions/workflows/frontend-ci.yml)
-[![NPM Version](https://badge.fury.io/js/chartlets.svg)](https://npmjs.org/package/chartlets)
+[![CI](https://github.com/bcdev/chartlets/actions/workflows/frontend-ci.yml/badge.svg)](https://github.com/bcdev/chartlets/actions/workflows/frontend-ci.yml)
+[![npm](https://badge.fury.io/js/chartlets.svg)](https://npmjs.org/package/chartlets)
 ![](https://img.shields.io/badge/Linting-TypeScript%20%26%20Prettier-blue?logo=typescript&logoColor=white)
 
-
-[![NPM Download Stats](https://nodei.co/npm/chartlets.png?downloads=true)](https://www.npmjs.com/package/chartlets)
-
 Chartlets is a software framework that allows websites developed with
 React to be extended by server-side widgets programmed in Python or other
 programming languages. 
 
-This is the JavaScript/React library of the framework.
+This is the **JavaScript/React library** of the framework.
 
 For details refer to the [documentation](https://bcdev.github.io/chartlets/).
 
-## Run the demo UI
-
-``` bash
-npm install
-npm run dev
-```