-
Notifications
You must be signed in to change notification settings - Fork 11
Setup
These are the setup and contribution instructions for Windows users
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/en/download/
- Open a Windows Command Prompt wherever you would like to work on translationCore.
- Run the command
git clone https://github.com/unfoldingWord-dev/translationCore.git
, or you may clone your own fork. - Change directories to the repository directory and run the command
npm install
to install all required Nodejs modules. - Create a file
Auth.json
in the root folder of the project. - Compile and run the project by running
npm run start
These are the setup and contribution instructions for Mac OS users
Git: Download and install X-Code Or to save time, just the necessary command line tools
Node and NPM: Download installer from https://nodejs.org/en/download/
- Open a Terminal wherever you would like to work on translationCore.
- Run the command
git clone https://github.com/unfoldingWord-dev/translationCore.git
, or you may clone your own fork. - Change directories to the repository directory and run the command
npm install
to install all required Nodejs modules. - Create a file
Auth.json
in the root folder of the project. - Run the command
npm run install-apps
to initiate the default tC tools. - Run the command
npm run pull-apps
to update to the latest release of the default tC tools. - Compile and run the project by running
npm start
The following scripts worked on a Linux Mint 18.2 release. They are the same as specified in the .travis.yml
file except that they do not have the headless environment variables specified.
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.4/install.sh | bash
nvm install node
git clone [email protected]:unfoldingWord-dev/translationCore.git
cd translationCore
npm run install-electron-forge
npm i -g [email protected]
npm install
npm install -g [email protected]
npm run install-apps
Then, run npm test
to see if the tests pass, or run npm run start
to get the app going.
Since the above should work, that doesn't mean it always does.
- There are many instances where dependencies like electron need to be installed globally to be able to run. You can fix that by running the command
npm install electron -g
if you don't have permissions, you'll need to use sudo on a mac/linux system,sudo npm install electron -g
.