New editor written in Python dialect
build | ||
res | ||
src | ||
.gitignore | ||
package.json | ||
README.md |
Getting started
-
Prerequisites:
- Installed git, npm
- Installed Python 3.7 as default python3 version
- Gitea account and access to
generic
organization
-
Download transcrypt version that supports -od parameter:
git clone https://github.com/QQuick/Transcrypt.git
cd Transcrypt
git checkout remotes/origin/dev_fall_2019
git switch -c dev_fall_2019
python3 setup.py build
python3 setup.py install --user
- Sometimes it will be found as
transcrpyt -V
and sometimes aspython3 -m transcrypt -V
-
Get api token for requests to lexonomy structure_conversions:
- Login to
https://gitea.cjvt.si/
- Navigate to Profile -> Settings
- Navigate to Applications
- Generate token, then copy token from the blue field above Manage Access Tokens card. If you fail to do so, delete that token and generate new one
- Save it in a plain file
- Login to
-
Setup lexonomy_custom_editor:
git clone https://gitea.cjvt.si/lexonomy/lexonomy_custom_editor.git
cd lexonomy_custom_editor
npm i
cd build
touch conversions.csv
- Run make with file content as variable:
API_KEY=$(cat location/to/file/name) make
- If any error occurs with conversions.csv or inside download_structure_conversions.sh, run make clean before starting the above command again
This concludes setup of local settings. You are ready to delve into it. To test, you can open main.html file inside /build
Best way to test is probably to deploy your editor version to https://lexonomy.cjvt.si/
- SSH required
- You need account and access to CJVT machine which admin can provide
- Connect with
ssh accountName -p password
, admin will provide sudo password - Create plugins directory on your account
- Move inside directory
- Give it 775 permissions (
sudo chmod 775 .
)
To deploy new test editor version:
- Note: This script builds current plugin version, uploads it to VPS and creates a symlink to location where server can pick them up.
- Navigate to /build and create local build_and_upload.sh script (
cp build_and_upload.sh.template build_and_upload.sh
) - Open build_and_upload.sh file and uncomment and configure the top 4 variables
- Whenever you want to upload new plugin to lexonomy, simply run
./build_and_upload.sh plugin_name
where you specify plugin_name. If specific plugin already exists, things might go bananas - You will be requested to enter sudo password for the VPS