PreTTY

PreTTY is prettier than PuTTY

Project Management & Documentation

Most document for this project should be managed via Git and hosted centrally on GitHub.

Project Wiki contains project management relevant documents. Please refer to Project Wiki (follow the instructions in Wiki pages for updating project document).

Detailed tasks for current project is briefly listed in Projects Section. For functionality that requires further discussion and planning, create an issue in Issues Section.

Development Setup

Install

# clone this repo
git clone git@github.com:Jack-Q/PreTTY.git
cd PreTTY

# install dependencies
# requires a node version >= 6 and an npm version >= 3
npm install

Important Note: The xterm module used here is an pre-release version that fetched directly from GitHub which is in lack of proper building process Please download/clone the full repo of xterm from GitHub and build using npm install in node_modules/xterm

Execute

# execute in development mode
# Chrome DevTools can be enable via F12 / Ctrl+Shift+I / Cmd+Alt+I
npm run dev

# execute in production-ready mode
npm run build && npm run start

note: on the first time of execution in development mode, it will try to install several DevTools extension from Chrome Extension Store.

Test

# unit test
npm run test

# e2e test
npm run build && npm run test-e2e

A simple SSH server is provide in this repo with extremely limited functionality, which can be used to test part of functionality of main program.

npm run ssh-server

Build / Package

# package for current platform
npm run package

note: Package process done by electron-builder

Licensed under MIT.

xiexinch / PreTTY