Skip to content

charlyoleg2/parametrix

Repository files navigation

Parametrix

Presentation

This is a monorepo that contains the following javascript packages:

  1. geometrix: the core library of parametrix
  2. designix: the first library of designs implemeted with geometrix
  3. geomui: the svelte library for creating easily a web-ui for geometrix-designs
  4. geomcli: the nodejs library for creating easily scripts and cli for geometrix-designs
  5. designix-script-ts: a nodejs script that showcases the usage of geomcli in tyepscript
  6. designix-script-js: a nodejs script that showcases the usage of geomcli in javascript
  7. designix-cli: a nodejs cli that showcases the usage of geomcli
  8. designix-ui: a sveltekit app that showcases geomui in a minimalist way
  9. designix-uis: a mini-web-server for distributing designix-ui via npm
  10. paramui: the main parametrix web-ui containing designix designs and various documentation

A public instance of paramui is available on that github-page. The code source is available on github.

Packages details

id package name lib or app browser env nodejs env published
1 geometrix lib yes yes geometrix
2 designix lib yes yes designix
3 geomui lib yes geomui
4 geomcli lib yes geomcli
5 designix-script-ts app yes
6 designix-script-js app yes
7 designix-cli app yes designix-cli
8 designix-ui app yes
9 designix-uis app yes designix-uis
10 parami-ui app yes

Prerequisite

  • node version 20.10.0 or higher
  • npm version 10.2.4 or higher

Getting started

git clone https://github.com/charlyoleg2/parametrix
cd parametrix
npm i
npm run ci
npm run preview

Other useful commands:

npm run ci2
npm run clean
npm run ls-pkg
npm -w geometrix run check
npm -w designix run build
npm -w paramui run dev

Publish a new release

npm run versions
git commit -am 'increment sub-package versions'
npm version patch
git push
git push origin v0.5.6