sea-liesch / ts-desktop Goto Github PK

A tool to translate the Bible and Open Bible Stories into your own language. You can read more about the purpose of this project at unfoldingWord.

##Requirements## The official development requirements are available at

• tS Requirements

Additional documentation specific to the desktop platforms is available in the wiki.

##Contributing If you would like to contribute to this project please read the Contributing article in the wiki.

##Quick Start First make sure you have NodeJS installed (choose the Current, not LTS). Then, in your terminal/command line window:

$ npm install -g bower
$ npm install -g gulp

Then fork this repository and clone your fork. After the repository has been cloned to your computer run the following command in the new directory to set up your environment

$ npm install && bower install

For more information please read the wiki.

###Commands The following commands are available from within the project directory:

• $ gulp build --win builds a windows distribution (other available flags are --osx and --linux)
• $ gulp test runs all Mocha unit tests
• $ gulp test --grep [string] runs the Mocha unit tests that match the string
• $ gulp runs the test task
• $ npm start runs the application (without building it)

Note: You can open the Chrome Developer Tools while the app is running by pressing Ctrl+Shift+I on Windows/Linux or Cmd-Shift-I on macOS.