lexonomy/lexonomy_custom_editor
7
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
New editor written in Python dialect
205 Commits 9 Branches 0 Tags 360 KiB
Python 91.7%
Less 5.5%
Shell 1.3%
Makefile 1.1%
HTML 0.2%
Other 0.2%
0b2bf53a6f
Go to file
Luka Kavčič 0b2bf53a6f Merge branch 'master' into lk-collocations-feature
2020-09-15 06:19:50 +00:00
build show structure at example edit 2020-09-03 10:51:32 +02:00
res explanationList 2020-08-10 08:38:08 -07:00
src Merge branch 'master' into lk-collocations-feature 2020-09-15 06:19:50 +00:00
.gitignore Feature#1405 and Bug#1399 2020-08-04 09:48:17 +02:00
package.json ske library support 2020-03-30 20:27:58 +02:00
README.md Improvement 2020-07-10 04:14:45 -07:00

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 as python3 -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

  • 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