You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Alexandre Stein 20889a418d
Separate the listener of configurator and hide button after outpu
2 months ago
.vscode Still very very early but may by showed 4 months ago
browser Separate the listener of configurator and hide button after outpu 2 months ago
.gitignore Start working on a packager script 3 months ago
README.md Just change some words 4 months ago
diagrams.drawio Add premitives for SFA commands and 18KX 4 months ago

README.md

Good Practice Tool

WARNING the package is under heavy development and is still a prototype before real work get started

The goal is to have:

  • a easy to use and simple tool
  • offline capable
  • search capable
  • which does not rely on heavy server side work (server only host the sources)

Install

Get the distributions files:

  • index.html
  • dist/bundle.js
  • style.css

And open index.html in your favorite browser.

Compile

Dependencies

System dependencies

To compile the sources to the distribution JavaScript file ne following packages are need:

  • nodejs
  • npm or yarn
  • git is optional

Sources dependencies

Go to the directory (browser for the moment) and install sources dependencies with:

npm install
# Or 
yarn install

Compilation

npm run build
# Or
yarn run build

This will generate the dist/bundle.js file which contains the all data and logic.