https://github.com/unfoldingword-dev/tooltemplate
The minimum amount of code to get a tool working in translationCore
https://github.com/unfoldingword-dev/tooltemplate
Last synced: 9 months ago
JSON representation
The minimum amount of code to get a tool working in translationCore
- Host: GitHub
- URL: https://github.com/unfoldingword-dev/tooltemplate
- Owner: unfoldingWord-dev
- Created: 2017-10-02T11:30:32.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-04-15T16:34:11.000Z (about 7 years ago)
- Last Synced: 2025-01-19T21:16:05.642Z (over 1 year ago)
- Language: JavaScript
- Size: 23.4 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# toolTemplate
This sample tool illustrates the minimum amount needed
to get a tool working in translationCore.
# Get started
1. Set up your development environment by installing: Git, Node ~v8, NPM v5.1.0.
1. Clone the translationCore repo, found at https://github.com/unfoldingWord-dev/translationCore
1. Run `npm install` from inside of the translationCore directory.
1. Run `npm run update-apps` to install/clone the application's external repositories.
1. Clone this repo locally inside of the `translationCore/tC_apps` path.
1. Run `npm start` to launch translationCore.
1. Login and find a project to open, you can click `Import from Online` and search for a Titus project.
1. Select the `toolTemplate` as your tool by clicking `Launch` located in it's box.
1. Now that the code runs, try editing the code in the `translationCore/tC_apps/toolTemplate` path.
## TODO:
- Once references to "apps" are renamed to "tools", update the references in this readme.