Skip to content

Commit f8db5d7

Browse files
starpitstarpit
committed
first commit
0 parents  commit f8db5d7

37 files changed

+23443
-0
lines changed

‎.gitignore

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# electron builds
2+
/dist
3+
4+
# warning for future reference: see https://github.com/IBM/kui/issues/209
5+
# /package-lock.json
6+
7+
# in case we have some leftover temporary build output
8+
/kui
9+
10+
# webpack and electron staging directories
11+
kui-*-tmp
12+
13+
packages/*/package-lock.json
14+
plugins/*/package-lock.json
15+
16+
*~
17+
#*
18+
dist/app
19+
dist/build
20+
dist/plugins
21+
*.log
22+
*.bak
23+
node_modules
24+
wskng.iml
25+
.pre-scanned.json
26+
app/.version
27+
app/build/webpack-stats.html
28+
app/content/**/*.js.map
29+
app/src/@kui-plugin
30+
.openwhisk-shell
31+
dump.rdb
32+
#openwhisk
33+
.idea
34+
.DS_Store
35+
app.inst
36+
.travis.yml.orig
37+
*_BASE*
38+
*_BACKUP*
39+
*_LOCAL*
40+
*_REMOTE*
41+
keys
42+
*flycheck*.ts
43+
*flycheck*.js
44+
*flycheck*.js.map
45+
/build
46+
*.bak.json
47+
48+
# these seem to come from node-pty or xterm.js
49+
.swp
50+
51+
# we will copy this file out of packages/kui-builder for local dev
52+
.npmrc
53+
54+
nohup.out
55+
56+
# tsc composite build files
57+
*.tsbuildinfo
58+
59+
# any temporary npm packs
60+
kui-shell-*.tgz
61+
62+
# mkclient.sh stage
63+
kui-stage
64+
65+
# es6 compiled modules
66+
packages/*/mdist
67+
plugins/*/mdist
68+
clients/**/mdist
69+
70+
# webpack-dev-server report
71+
report.*.json
72+
73+
# packages/builder/dist/electron currently generates this and does not remove it
74+
/kubectl-kui

‎README.md

+77
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Client Template for the Kui Graphical CLI Framework
2+
3+
[Kui](https://github.com/kubernetes-sigs/kui) is a framework for
4+
extending CLIs with graphical enhancements. If you wish to extend the
5+
framework, either by adding custom commands, custom views, or custom
6+
theming, this is the place to start!
7+
8+
This repository offers a few silly animal-oriented commands and views,
9+
including a way to decorate Kubernetes resources with additional tabs.
10+
11+
## Getting Started with Development
12+
13+
```sh
14+
npm ci
15+
npm run watch
16+
```
17+
18+
This will spawn the Webpack watcher. Once it has finished loading, you
19+
may open a Kui window via `npm run open`. If this works, you are all
20+
set for developing your Kui-based magic.
21+
22+
## Details of the customizations in this client
23+
24+
This [wiki](https://github.com/kubernetes-sigs/kui/wiki) introduces
25+
the ways in which this application enhances Kui. In particular, this
26+
client extends Kui with:
27+
28+
<img src="docs/images/cattab.png" align="right" width="350" title="Showing the Kubernetes decorations">
29+
30+
- Decorations for Kubernetes resources: a `Cat` tab, a 🐶 button, and a 🐱 badge (shown in the upper right with a green background).
31+
32+
- A set of
33+
[commands](plugins/plugin-example/src/commands)
34+
that use Kui's built-in views. [More info](https://github.com/kubernetes-sigs/kui/wiki#approaches-for-enhancing-kui)
35+
- `hello cat` and `hello dog` are simple hello worlds that returns a cat and dog emoji, respectively
36+
- `hello sidenav` and `hello catnav` which show how to use the multi-tab "sidecar" views, with tabs on top
37+
and tabs on the left, respectively
38+
39+
<img src="docs/images/catdogwidget.gif" align="right" width="350" title="Showing the CatDogWidget StatusStripe widget">
40+
41+
- A [StatusStripe widget](plugins/plugin-example/src/view/CatDogWidget.tsx) that will be placed along the bottom of the Kui window. [More info](https://github.com/kubernetes-sigs/kui/wiki#approaches-for-enhancing-kui)
42+
43+
### More Documentation on Extending Kui
44+
45+
- [Kui Command Documentation](https://github.com/kubernetes-sigs/kui/wiki/1.-Commands) and [Terminal View Documentation](https://github.com/kubernetes-sigs/kui/wiki/2a.-Terminal-View) uses the [string](plugins/plugin-example/src/view/string), [boolean](plugins/plugin-example/src/view/boolean), and [table](plugins/plugin-example/src/view/table) view as examples of Terminal-oriented command response.
46+
47+
- [TopNavSidecar View Documentation](https://github.com/kubernetes-sigs/kui/wiki/2b.-TopNavSidecar-View) uses [this](plugins/plugin-example/src/view/mmr-example.ts) as an example of TopNavSidecar-oriented command response.
48+
49+
- [LeftNavSidecar View Documentation](https://github.com/kubernetes-sigs/kui/wiki/2c.-LeftNavSidecar-View) uses [this](plugins/plugin-example/src/view/nav-example.ts) as an example of LeftNavSidecar-oriented command response.
50+
51+
## Building for Production: Electron Double-clickables
52+
53+
If you want to build and distribute your own double-clickable
54+
Electron-based clients, then use one of these commands, after which
55+
your clients will be placed in `./dist/electron`.
56+
57+
```sh
58+
npm run build:electron:all # does all of the following...
59+
npm run build:electron:mac:amd64
60+
npm run build:electron:mac:arm64
61+
npm run build:electron:linux:amd64
62+
npm run build:electron:linux:arm64
63+
npm run build:electron:windows:amd64
64+
```
65+
66+
## Building for Production: Hosted Web App
67+
68+
To build a hosted version of Kui, running in a Docker container, use
69+
this command:
70+
71+
```sh
72+
npx kui-build-docker-with-proxy
73+
```
74+
75+
This will generate a Docker image `kui-shell/kui`. To test this
76+
production web app, you can use the script `npx kui-run-cproxy`, and
77+
then visit `http://localhost:9080`.

‎bin/switch-client.sh

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
#!/usr/bin/env bash
2+
3+
#
4+
# Copyright 2020 The Kubernetes Authors
5+
#
6+
# Licensed under the Apache License, Version 2.0 (the "License");
7+
# you may not use this file except in compliance with the License.
8+
# You may obtain a copy of the License at
9+
#
10+
# http://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
#
18+
19+
set -e
20+
set -o pipefail
21+
22+
SCRIPTDIR=$(cd $(dirname "$0") && pwd)
23+
cd "$SCRIPTDIR"/..
24+
25+
export CLIENTPATH="plugins/plugin-client-$1"
26+
27+
if [ ! -e $CLIENTPATH ]; then
28+
echo "$(tput setaf 1)Error$(tput sgr0): Specified client does not exist $PWD/$CLIENTPATH"
29+
exit 1
30+
elif [ ! -e $CLIENTPATH ]; then
31+
echo "$(tput setaf 1)Error$(tput sgr0): Specified client directory does not exist $PWD/$CLIENTPATH"
32+
fi
33+
34+
echo "$(tput setaf 3)Switching to client $1...$(tput sgr0)"
35+
36+
(cd node_modules/@kui-shell && rm -f client && ln -s ../../$CLIENTPATH client)
37+
38+
npm run compile
39+
40+
echo "$(tput setaf 2)ok$(tput sgr0): Successfully switched to client $1"

0 commit comments

Comments
 (0)