alterebro / IPA-Keyboard

IPA Keyboard. International Phonetic Alphabet Symbols Web and Desktop Application built using Vue.js, Gulp and Node-Webkit

IPA Keyboard: git.io/ipa

International Phonetic Alphabet Symbols Web and Desktop Application built using Vue.js, Gulp and Node-Webkit (nw.js). Responsive Cross-Browser Web Application and standalone Desktop Cross-Plattform Application for Mac OSX, Windows and Linux.

• WebApp : http://alterebro.github.io/IPA-Keyboard/
• Desktop App Pre-Release Binaries ( v1.0-alpha pre-release page ) :
  • Windows 64bit
  • Mac OSX 64
  • Linux 64bit

Build

Requirements : Node.js and gulp. Download and Install Node.js if you don't have it installed already on your computer from the node website, install gulp globally. In case you have a previous gulp version run npm rm --global gulp in order to avoid collision with the gulp-cli.

# Install gulp globally
$ npm install --global gulp-cli  # ( with sudo on OSX )

# Clone the ipa keyboard repository
$ git clone https://github.com/alterebro/IPA-Keyboard

# Install development dependencies
$ npm install

# Build the www distributable folder
$ gulp build

# Build the nwjs app
$ gulp nw

When building the desktop app for specific operating system, modify the gulpfile.js file where the nw task contains a platform array, these are the possible values : ['win32', 'win64', 'osx32', 'osx64', 'linux32', 'linux64'] Just select those you want to be built. More info about the builder option s on the nw-builder repo page ( https://github.com/nwjs/nw-builder )

Publish

Public website is generated on the www/ folder and located on the gh-pages branch ( http://alterebro.github.io/IPA-Keyboard/ ). Build it with gulp and push only that folder to gh-pages.

# ... do your changes
# Build the www distributable folder
$ gulp build

# ... pushing master
$ git status
$ git add .
$ git commit -m 'commit message'
$ git push origin master

# push www/ to gh-pages
$ git subtree push --prefix www/ origin gh-pages

Credits

IPA Keyboard by Jorge Moreno aka moro (moro.es, @alterebro)

• Built using :
  • NW.js (node-webkit) lets you call all Node.js modules directly from DOM and enables writing native applications with Web technologies.
  • Gulp Task runner, streaming build system.
  • Vue.js Reactive Components for Modern Web Interfaces.

---

The IPA Keyboard is MIT licensed. Copyright © 2016 Jorge Moreno