desktop-transfer-client v0.0.15
desktop-transfer-client
A desktop client, running on electron, used for uploading and downloading assets
Prerequisites
Transfer SDK
The transfer-sdk is a private github repo. Go will have problems building the Go binary.
First you need to make sure that all your github interactions are done over ssh. The following will set all github communication to default to the ssh address (instead of the https) of the repo. You'll have to add this to your ~/.gitconfig
:
[url "ssh://git@github.com/"]
insteadOf = https://github.com/
We need to tell Go that our transfer-sdk is a private repo. Otherwise it can't access it. Therefore edit your ~/.bashrc
file and add the following:
export GOPRIVATE="github.com/Frameio"
Working off a branch
If you're working on a specific branch of the transfer-sdk repo and need the changes, then you'd "pull" the branch like this:
go get -u github.com/Frameio/transfer-sdk@MY_BRANCH
The -u
flag stands for update
. Your local copy of the branch is updated, and you can use it in Salto.
Make sure you don't commit the go.mod
and go.sum
file, unless you're targeting the develop
branch.
Build
Install depencies by calling yarn
in the project's root.
Development
yarn start
- builds the go binary and spins up a server that runs the frontend code
Production
yarn make
- will create all do all the building magic for you. The final result is in the out/make/..
folder
Troubleshooting
Error: Cannot open .../desktop-transfer-client/node_modules/keytar/build/Release/keytar.node: Error: Module did not self-register.
In this case delete the node_module folder and yarn:
rm -rf ./node_modules; yarn;