Setup

Windows

These are the setup and contribution instructions for Windows users

Dependencies

Git: Download installer from https://git-scm.com/ Install using whatever settings you would like, as long as you make sure to choose the option that allows git to be accessible from the Windows Command Prompt.

Node and NPM: Download installer from https://nodejs.org/download/release/v8.16.1/. Download the appropriate .msi file for Windows (node-v8.16.1-x64.msi for 64-bit or node-v8.16.1-x86.msi for 32-bit). Run the downloaded installer.

Project Setup

1. Open a Windows Command Prompt wherever you would like to work on translationCore.
2. Run the command git clone https://github.com/unfoldingWord/translationCore.git, or you may clone your own fork.
3. Change directories to the repository directory and run the command npm ci to install all required Nodejs modules.
4. npm run load-apps will check out versioned submodule commit
5. Compile and run the project by running npm run start

Mac

These are the setup and contribution instructions for Mac OS users

Dependencies

Git: Part of developer tools. May not have to download - try doing git --version which should prompt to download if not already installed (or give the version of git if already set up). If that fails you can either get the full Developer Tools, download and install X-Code. Or to save time, just the necessary command line tools

Node and NPM: Download installer from https://nodejs.org/download/release/v8.16.1/node-v8.16.1.pkg. Right click on downloaded pkg file and select open.

Project Setup

1. Open a Terminal wherever you would like to work on translationCore.
2. Run the command git clone https://github.com/unfoldingWord/translationCore.git, or you may clone your own fork.
3. Change directories to the repository directory and run the command npm ci to install all required Nodejs modules.
4. npm run load-apps will check out versioned submodule commit
5. Compile and run the project by running npm start

To make a MacOs install for translationCore app, do npm run release-osx. When done, the output will be in npm release folder.

Linux

The following worked on Linux Mint 19. First make sure you have installed latest updates.

Type in terminal:

curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.4/install.sh | bash

Restart Terminal and type in commands:

nvm install 8.16.1
git clone https://github.com/unfoldingWord/translationCore.git
cd translationCore
npm i -g npm@6.4.1
npm run load-apps
npm ci

Then, run npm test to see if the tests pass, or run npm run start to get the app going.