agama/web/README.md
Martin Vidner 03af9ac96a JSDoc: put it in jsdoc.out/ instead of out/
to make its purpose and context more obvious
2022-06-10 16:09:10 +02:00

1.2 KiB

D-Installer Web-Based UI

This Cockpit modules offers a UI to the D-Installer service. The code is based on Cockpit's Starter Kit (b2379f7).

Development

Cockpit searches for modules in the $HOME/.local/share/cockpit directory of the logged in user, which is really handy when working on a module. To make the module available to Cockpit, you can link your build folder (dist) or just rely on the devel-install task:

    make devel-install

Bear in mind that if something goes wrong while building the application (e.g., the linter fails), the link will not be created.

While working on the code, you might want to run the following command to refresh the build everytime you save a change:

    npm run watch

However, there is no live or hot reloading feature, so you need to reload the code in your browser. You can visit the module through the following URL: http://localhost:9090/cockpit/@localhost/d-installer/index.html.

JSDoc Documentation

npm run jsdoc
xdg-open jsdoc.out/index.html

GitHub Actions will automatically publish the result to https://d-installer-frontend.surge.sh/