wmarques / klingon

Klingon: The UI companion for the @angular/cli

Angular Klingon

The perfect @angular/cli companion.

---

Klingon App	Klingon UI	Klingon Server	Klingon Website

Repo organisation

This monorepo hosts 4 projects:

1. klingon-ui: the core application: the companion app. This app is built using the @angular/cli.
2. 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.
3. klingon-app: the electron shell host for the companion application.
4. klingon-website: the source code for angular.run.

Contributions

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. Please contact me (@manekinekko) if you need some help getting started with the setup.

How to run locally (wip)

1. Install electron if it hasn't been done already.
2. Run the server npm run start:server
3. Run the ui npm run start:ui
4. Run the application within the electron shell npm run start:app or go to http://localhost:4200

How to package the application

• For OSX npm run package:app:osx
• For Windows npm run package:app:win (not tested yet)
• For Linux npm run package:app:linux (not tested yet)