{"id":23327894,"url":"https://github.com/kui-shell/kuinotebookbuilder","last_synced_at":"2025-04-07T08:33:42.979Z","repository":{"id":46411437,"uuid":"417253962","full_name":"kui-shell/KuiNotebookBuilder","owner":"kui-shell","description":"Template focused on browser-based Kui Notebook clients","archived":false,"fork":false,"pushed_at":"2021-10-15T17:38:56.000Z","size":360,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-13T12:18:36.078Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kui-shell.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-10-14T19:13:23.000Z","updated_at":"2021-10-15T17:38:59.000Z","dependencies_parsed_at":"2022-09-23T00:31:19.383Z","dependency_job_id":null,"html_url":"https://github.com/kui-shell/KuiNotebookBuilder","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kui-shell%2FKuiNotebookBuilder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kui-shell%2FKuiNotebookBuilder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kui-shell%2FKuiNotebookBuilder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kui-shell%2FKuiNotebookBuilder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kui-shell","download_url":"https://codeload.github.com/kui-shell/KuiNotebookBuilder/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247621181,"owners_count":20968399,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-20T20:53:46.202Z","updated_at":"2025-04-07T08:33:42.953Z","avatar_url":"https://github.com/kui-shell.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Kui Notebook Builder\n\nThis repository helps you to build a set of webpack bundles that can\nhost a fixed set of Kui Notebooks. The build is dockerized, so you\ndon't even need to clone this template repository to get started.\n\n## Quick Start (no need to clone this repo)\n\n```sh\ndocker run --rm \\\n       -v \"$BUNDLE_TARGET_DIR\":/kui/dist/webpack \\\n       -v \"$NOTEBOOKS_DIR\":/config.d \\\n       -v \"$CONFIG_DIR\":/config.d \\\n       -e OFFLINE=$OFFLINE \\\n       quay.io/kuishell/notebook-builder\n```\n\nYou will need to specify three inputs:\n\n1. `$BUNDLE_TARGET_DIR`: absolute path to the target directory for the\n   generated web app (index.html, etc.).\n2. `$NOTEBOOKS_DIR`: absolute path to your [Kui\n   Notebooks](#authoring-notebooks).\n2. `$CONFIG_DIR`: absolute path to your config choices, such as the\n   name of the application.\n3. `OFFLINE=true|false`. If you want a [static single page\n   application](https://en.wikipedia.org/wiki/Single-page_application),\n   set `OFFLINE=true`. (Coming soon: quick builds for a hosted\n   client/server architecture) \n\nA suggested usage is to instantiate this template repository once per\ndesired web application. This lets you store the `config.d` elements\n(application name, set of notebooks) on a per-app basis. Also, if you\nclone the repository, this process is slightly simplified:\n\n```sh\n./build.sh /tmp/bundles $PWD/notebooks $PWD/config.d offline\n```\n\n## Live Watching\n\nIf you wish to to live development, use the `watch.sh` script in place\nof `build.sh`. Once the watcher is up, you can visit\n`http://localhost:9080`. Changes to your notebooks or to your config.d\nentries should be reflected on that web page.\n\n## `config.d`: Specifying your application name, etc.\n\nYou may find an example configuration directory [here](config.d). You\nmay set the application title and favicon here. See the [example\nconfig](config.d) for guidance.\n\n## Authoring Notebooks\n\n[Download Kui](https://github.com/kubernetes-sigs/kui/releases). You\nmay find help in the stock Kui client by consulting the\n`Notebooks-\u003eMake Your Own Notebook` menu. Once you have a candidate\nnotebook, do a File-\u003eSave, and save it to your `config.d/notebooks`\ndirectory.\n\n## Advanced\n\nIf for some reason you need to generate a custom base image, consult\nthe [advanced documentation](advanced/README.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkui-shell%2Fkuinotebookbuilder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkui-shell%2Fkuinotebookbuilder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkui-shell%2Fkuinotebookbuilder/lists"}