mrtoth/frontend-tutorial-framework
1
0
Fork 0
mirror of https://github.com/avatao-content/frontend-tutorial-framework synced 2025-04-03 11:52:40 +00:00
Code Issues Releases Wiki Activity

Perform small language improvements on README

Browse Source
This commit is contained in:
Kristóf Tóth 2018-04-26 10:41:15 +02:00
parent e9096b11aa
commit 2990b5009b
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -32,12 +32,12 @@ A full-fledged xterm terminal emulator based on xterm.js running right in your b
The emulator is connected to a `TerminalEventHandler` instance on the backend over websockets. The emulator is connected to a `TerminalEventHandler` instance on the backend over websockets.
This event handler spawns a `bash` session and a `pty` (pseudoterminal). This event handler spawns a `bash` session and a `pty` (pseudoterminal).
It connects the master end of the `pty` to the emulator running in the browser and the slave end to `bash`. It connects the master end of the `pty` to the emulator running in your browser and the slave end to `bash`.
This essentially provides a fully functional terminal session for your users in the browser (a convenient alternative for an SSH session). This essentially provides a fully functional terminal session for your users in the browser (a convenient alternative for an SSH session).
This terminal is fully under your control: This terminal is fully under your control:
You can write to it (and thus execute commands) and read what commands were executed by the user using the API exposed by the `TerminalEventHandler` instance. You can write to it (and thus execute commands) and read what commands were executed by the user using the API exposed by the `TerminalEventHandler`.
This enables you to pre-type or execute commands for the user and figure out what they are doing in the terminal. This enables you to pre-type or execute commands for the user and figure out what they are doing in the terminal.
@ -80,6 +80,7 @@ There are two ways to do this:
If you'd like to avoid Angular you can run your own webserver on the backend and use our dashboard's `iframe`ing capabilities to include it. If you'd like to avoid Angular you can run your own webserver on the backend and use our dashboard's `iframe`ing capabilities to include it.
To enable this feature you have to edit `src/app/config.ts` and set `config.dashboard.iframeUrl` to the route your server is listening on. To enable this feature you have to edit `src/app/config.ts` and set `config.dashboard.iframeUrl` to the route your server is listening on.
Note that setting up a custom server is documented in the [test-tutorial-framework](https://github.com/avatao-content/test-tutorial-framework) repo. Note that setting up a custom server is documented in the [test-tutorial-framework](https://github.com/avatao-content/test-tutorial-framework) repo.
Alternatively you can create your own Angular component(s) in `src/app/web`. Alternatively you can create your own Angular component(s) in `src/app/web`.
@ -92,7 +93,7 @@ The dashboard is the component that composes all others and organises them into
Edit `src/app/config.ts` to change the layout settings. Edit `src/app/config.ts` to change the layout settings.
Set `config.dashboard.currentLayout` to the layout you want to display by default. Set `config.dashboard.currentLayout` to the layout you want to be displayed by default.
You can specify the layouts you allow in `config.dashboard.enabledLayouts` (the user can switch between them using a sidebar). You can specify the layouts you allow in `config.dashboard.enabledLayouts` (the user can switch between them using a sidebar).
This list must include the value of `currentLayout`. This list must include the value of `currentLayout`.
@ -107,7 +108,7 @@ Available layouts– with self explaining names:
- `ide-only` - `ide-only`
- `web-only` - `web-only`
It also exposes a frontend API to dynamically change layouts any time using a message format as such (note that the layout you switch to must be enabled): The dashboard also exposes a frontend API to dynamically change layouts any time using a message format as such (note that the layout you switch to must be enabled):
``` ```
{ {
@ -121,4 +122,4 @@ It also exposes a frontend API to dynamically change layouts any time using a me
} }
``` ```
You can use the `hide_messages` key to hide the message component (sadly it currently still takes up the space it would occupy). You can use the `hide_messages` key to hide the message component (sadly it currently takes up the space it would occupy).