Quine's fork of "Hyper" by Vercel, A terminal built on web technologies
Find a file
Philippe Potvin ab703b5bf2 Add docs for keys modification (#1937)
* Add keymaps docs to website

* de-beautify
2017-06-14 21:03:41 -04:00
.github Update issue template to show how checkboxes work (#1649) 2017-03-14 16:30:36 +01:00
app Add docs for keys modification (#1937) 2017-06-14 21:03:41 -04:00
assets Windows titlebar improvements (#1307) 2017-01-10 21:45:49 -08:00
bin Make npm run clean platform agnostic (#1901) 2017-06-13 00:58:30 +02:00
build Add Windows support and first-class Linux support (#946) 2016-11-11 15:18:04 -02:00
lib Escape parentheses for dropped files/folders (#1935) 2017-06-14 09:12:03 -07:00
test Unit tests for to-electron-background-color (#1409) 2017-02-16 15:44:44 -03:00
website Add docs for keys modification (#1937) 2017-06-14 21:03:41 -04:00
.editorconfig Fix for markdown files (#618) 2016-08-14 21:10:41 +02:00
.gitattributes Ensure line endings are correct on Windows (#1230) 2017-01-02 17:56:47 -02:00
.gitignore Use local config file in dev. Fix #903 (#904) 2017-01-04 20:05:19 -05:00
.npmrc Split Panes (#693) 2016-10-03 19:00:50 -07:00
.travis.yml 🌹 Update travis node (#1900) 2017-06-02 20:04:36 -04:00
appveyor.yml Use yarn for everything 2017-02-23 18:02:53 -03:00
license.md Lowercased text files 2017-02-22 23:08:34 +01:00
package.json Addressing yarn run dist issues. (#1928) 2017-06-14 02:44:33 +02:00
readme.md Cleanup readme (#1934) 2017-06-14 04:16:43 +02:00
webpack.config.js Upgrade electron to 1.6.8 (#1848) 2017-05-20 14:35:11 -07:00
yarn.lock Addressing yarn run dist issues. (#1928) 2017-06-14 02:44:33 +02:00

Build Status Build status Slack Channel Changelog #213 XO code style

For more details, head to: https://hyper.is

Usage

Download the latest release!

If you're on macOS, you can also use Homebrew Cask to download the app by running these commands:

brew update
brew cask install hyper

If you're on windows, you can use chocolatey to install the app by running the following command (package information can be found here):

choco install hyper

Note: the version of hyper available from chocolatey may not be the latest. Consider using the direct download link, https://hyper-updates.now.sh/download/win

Contribute

  1. Install the dependencies
  • If you are running Linux, install icnsutils, graphicsmagick, xz-utils and rpm
  • If you are running Windows, install windows-build-tools with yarn global add windows-build-tools.
  1. Fork this repository to your own GitHub account and then clone it to your local device
  2. Install the dependencies: yarn
  3. Build the code and watch for changes: yarn run dev
  4. In another terminal tab/window/pane, run the app: yarn run app

To make sure that your code works in the finished application, you can generate the binaries like this:

yarn run dist

After that, you'll see the binary in the ./dist folder!

Known issues that can happen during development

Error building node-pty

If after building during development you get an alert dialog related to node-pty issues, make sure its build process is working correctly by running yarn run rebuild-node-pty.

If you're on macOS, this typically is related to Xcode issues (like not having agreed to the Terms of Service by running sudo xcodebuild after a fresh Xcode installation).

Error with codesign on macOS when running yarn run dist

If you have issues in the codesign step when running yarn run dist on macOS, you can temporarily disable code signing locally by setting export CSC_IDENTITY_AUTO_DISCOVERY=false for the current terminal session.