Package | Version | Description |
---|---|---|
klingon-app | the electron shell host for the companion application. | |
klingon-ui | the core application: the companion app. This app is built using the @angular/cli. | |
klingon-server | the server (agent) application that serves a backend for the companion application. Its role is to spin up PTY instances and allow the companion app to communicate with those PTY instances via WebSocket. | |
klingon-website | the source code for angular.run. |
npm run start:server
npm run start:ui
npm run start:app
or go to http://localhost:4200npm run package:app:osx
npm run package:app:win
(not tested yet)npm run package:app:linux
(not tested yet)You are welcome to contribute to this project. This project is still in its early stage, no feature is frozen yet. All suggestions/fixes/help are more than welcome. Add your feedback to this todo list for feature requests.
Please contact me (@manekinekko) if you need some help getting started with the setup.
Want to file a bug, contribute some code, or improve documentation? Excellent !Read up on our guidelines for contributing.