Skip to content

Latest commit

 

History

History
81 lines (55 loc) · 2.91 KB

README.md

File metadata and controls

81 lines (55 loc) · 2.91 KB

Wings · Build Status Coverage

A text editor inspired by Vim, written in JavaScript and React.

Caveat emptor: this application is built for my own needs and is almost certainly of no direct use to anyone else.

Demo

Download

The latest Mac release is available for download here. Note that releases are built infrequently and that you can also build the app yourself.

Usage

Wings is heavily inspired by Vim and currently supports a subset of its commands, in addition to some new features. At this time there is no proper documentation or even a list of features, but you can explore the keys section of the default config to learn more.

Development

In order to run Wings in development mode you will need Git, Node.js and ideally Yarn. Once you have all of those installed, you may fetch the project and install its dependencies as follows:

git clone [email protected]:hph/wings.git
cd wings
yarn

In order to build the app and automatically rebuild it when the code is changed, open a new terminal in the same directory and run:

yarn build:dev

You should now be able to go back to the previous terminal and start Wings:

yarn start

You may optionally provide an argument to open a file, such as package.json:

yarn start package.json

Development tools

The project is set up with a comprehensive test suite, a linter, and a formatter. You may run all of these as follows:

yarn test

If you wish to run the test suite, linter, or formatter separately, run one of the following commands as appropriate:

yarn lint      # Run ESLint directly
yarn format    # Run Prettier directly
yarn test:only # Run the test suite

You can see the results for the linter, formatter and tests for the master branch on Travis CI and code coverage information on Coveralls. Builds are automatically run against all branches and pull requests.

Building for production

The build process is a bit slower in production mode as it minifies the code and also builds the app into a single package. Run the following command:

NODE_ENV=production yarn build

The production build has only been tested on a Mac. If you run into any issues, please open an issue.