https://github.com/hph/wings

A text editor inspired by Vim, written in JavaScript and React.
https://github.com/hph/wings

editor electron react redux

Last synced: 15 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/hph/wings
• Owner: hph
• License: mit
• Created: 2017-08-22T20:09:38.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T22:01:37.000Z (almost 2 years ago)
• Last Synced: 2024-10-04T15:33:27.896Z (about 1 month ago)
• Topics: editor, electron, react, redux
• Language: JavaScript
• Homepage:
• Size: 3.06 MB
• Stars: 16
• Watchers: 4
• Forks: 0
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Wings · [![Build Status](https://img.shields.io/travis/hph/wings/master.svg?style=flat-square)](https://travis-ci.org/hph/wings) [![Coverage](https://img.shields.io/coveralls/hph/wings/master.svg?style=flat-square&label=test%20coverage)](https://coveralls.io/github/hph/wings)

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](https://www.dropbox.com/s/qog2a5d8rdcjs6q/Wings.png?raw=1)

## Download

The latest Mac release is available for download

[here](https://github.com/hph/wings/releases). Note that releases are built

infrequently and that you can also [build the

app](https://github.com/hph/wings#building-for-production) 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](https://github.com/hph/wings/blob/master/src/main-process/default-config.json)

to learn more.

## Development

In order to run Wings in development mode you will need

[Git](https://git-scm.com/download), [Node.js](https://nodejs.org/en/download/)

and ideally [Yarn](https://yarnpkg.com/en/docs/install). 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:

```bash

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](https://travis-ci.org/hph/wings) and code coverage

information on [Coveralls](https://coveralls.io/github/hph/wings). 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](https://github.com/hph/wings/issues/new).