Script Kit App
Join the Discussion
https://github.com/johnlindquist/kit/discussions
Script Kit Dev Setup
Note: This ain't pretty π
Requirements: yarn 1
Why both npm and yarn?
The App was created with https://github.com/electron-react-boilerplate/electron-react-boilerplate a long time ago. They require yarn and webpack.
I have been unable to prioritize the time to switch over to another build system or keeping up with the boilerplate, especially with so many moving pieces.
Thus, we use yarn to build the App and npm to build the SDK π€¦ββοΈ
Using node 18.16.1 from ~/.knode
Installing Kit.app
already installed node 18.16.1 to ~/.knode. You'll want to use this node version for all build/run steps:
PATH=~/.knode/bin:$PATH
This will use 18.16.1's node/npm when working with Kit. (Alternatively, you can use nvm/n/whatever, but I don't)
- Use
volta
to manage node versions.- Install volta
- Volta will automatically switch node version to 18.16.1 when working with kit.
Clone Kit SDK
Clone:
git clone https://github.com/johnlindquist/kit.git
Install:
npm install
Clone Kit App
Clone:
git clone https://github.com/johnlindquist/kitapp.git
Install:
yarn
(Skip if you already have a kenv from production) Clone the base kenv
Clone:
git clone https://github.com/johnlindquist/kenv.git ~/.kenv
Building Kit SDK
npm run build-kit
The build command builds the SDK to ~/.kit
yarn link (First run only)
- cd to ~/.kit
- yarn link
- cd to ~/wherever you cloned kitapp
- yarn link @johnlindquist/kit
This will force the App to use the SDK so you can work on both simultaneously
Building the App
yarn webpack-dev
yarn install-electron-deps
yarn start
Assuming everything went well, the app should start up.