Skip to content

Latest commit

 

History

History
33 lines (22 loc) · 991 Bytes

README.md

File metadata and controls

33 lines (22 loc) · 991 Bytes

yterm

yterm is a terminal emulator in web. Similar project xterm.js. My project proposal and weekly rubrics can be found here

Project structure

This project is based on typescript and node.

src/yterm contains source code for the in browser module. src/server contains a simple server side program that opens a websocket interface, which, upon connection, will open a bash process and feed the info back to the client (only bind this to localhost!)

src/test.ts contains a simple in browser script that uses the module and it's used in test.html at the root.

tests contains tests of the yterm module.

Usage

npm install
npm run build # build yterm module and the test script
npm run server # start up the server

# open test.html now and you should be able to see a terminal screen

Tests and coverage

npm run test
npm run coverage