Browse Source

Readme updated

matic_t 2 years ago
  1. 55
  2. 4


@ -1,8 +1,49 @@
# Build
To build, you need transcrypt, you need to do npm install and then you need api key for gitea (`token=$API_KEY`), just find this on, not that hard.
After you have all of this, move to build folder, set `API_KEY` environment variable and then build it just using `make` or for release use `make release` - optimized javascript build.
For me its `API_KEY=(cat ~/.gitea_api_key) make`.
**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`
- `cd Transcrypt`
- `git checkout remotes/origin/dev_fall_2019`
- `git switch -c dev_fall_2019`
- `python3 build`
- `python3 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 ``
- 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`
- `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, 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
- 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:
- Navigate to /build and create local script (`cp`)
- Open file and uncomment and configure the top 4 variables
- Whenever you want to upload new plugin to lexonomy, simply run `./ 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


@ -4,8 +4,6 @@
#VPS_PASSWORD= vps password
#VPS_USERNAME= user name inside vps
#API_KEY= $(cat path/to/api/token/file)
echo "Must uncomment and fill in variables inside"
exit 1
if [[ -z "$1" ]]; then
@ -16,5 +14,5 @@ fi
tar czf - ./config.json ./bundle.js ./local.js ./main.css ./main.html | ssh $USERNAME -p $VPS_PASSWORD "cd plugins && mkdir -p $PLUGIN_NAME && cd $PLUGIN_NAME && tar xvzf -"
tar czf - ./config.json ./bundle.js ./local.js ./main.css ./main.html | ssh $USERNAME -p $VPS_PASSWORD "cd plugins && mkdir $PLUGIN_NAME && cd $PLUGIN_NAME && tar xvzf -"
ssh -t $USERNAME -p $VPS_PASSWORD "sudo ln -s /home/$VPS_USERNAME/plugins/$PLUGIN_NAME /home/ozbolt/plugins/$PLUGIN_NAME"