aboutsummaryrefslogtreecommitdiff

pakakeh.ts

A HTML web-user interface components built with TypeScript.

Components

List of components,

  • editor: WYSIWYG text editor built with contenteditable.

  • input/checkboxes: Input with check boxes.

  • input/file: Input with file.
  • input/number: Input with number.
  • input/select: Input by selection, drop down items.
  • input/string: Input with string.

  • notif: component to display notification.

  • vfs: virtual file system to browser files using predefined APIs.

Development

Requirements,

  • Go version 1.22.0 or later
  • nodejs version 21.7.0 or later.
  • TypeScript version 5.2.2 or later.

First, install the dependencies using npm,

$ npm install

added 170 packages, and audited 171 packages in 4s

58 packages are looking for funding
  run `npm fund` for details

found 0 vulnerabilities

$

Second, install the third party tools built with Go,

$ make install-tools
go install git.sr.ht/~shulhan/ciigo/cmd/ciigo@latest
$

Run make watch to start watching changes to .ts files,

$ make watch
[01:03:49] File change detected. Starting incremental compilation...

[01:03:49] Found 0 errors. Watching for file changes.

Open new terminal and run make serve to serve the content,

$ make serve
ciigo -exclude="(node_modules)" -address=127.0.0.1:4578 serve .
2024/05/10 01:13:10 ciigo: starting HTTP server at http://127.0.0.1:4578 for "."

Let it run in background and open http://127.0.0.1:4578 in the browser.

Edit TypeScript files and wait for the changes to be compiled and preview or test the changes in the browser.

Happy hacking!

Coding style

  • Use snake_case for field, variable, HTML ID, and CSS class names.
  • Use camelCase for class, interface, type, function, or method names.
  • An exported type or class. interface, type, method, or function name MUST start with an upper-case letter.
  • An exported class, type, interface, or function MUST be prefixed with "Wui".
  • Use the WuiResponseInterface for non-void return type.

References