https://github.com/johnlindquist/kit/discussions
https://github.com/johnlindquist/kit-docs
❤️ Sponsor me on GitHub ❤️
Shipped | Planned |
---|---|
Built-in Debugger | Sync Scripts to GitHub Repo |
Script Log Window | Run Script Remotely as GitHub Actions |
Support through Discord | Advanced Widgets |
Screenshots | |
Screen Recording | |
Desktop Color Picker | |
Measure Tool | |
Debug from IDE |
Note: This ain't pretty 😅
Requirements: yarn 1
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 🤦♂️
Note: A huge focus of v3 will be to clean up this mess and make it much, much easier to contribute.
Installing Kit.app
already installed node 18.18.2 to ~/.knode. You'll want to use this node version for all build/run steps:
PATH=~/.knode/bin:$PATH
This will use 18.18.2'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.18.2 when working with kit.
Clone:
git clone https://github.com/johnlindquist/kit.git
Install:
npm install
Clone:
git clone https://github.com/johnlindquist/kitapp.git
Install:
yarn
Clone:
git clone https://github.com/johnlindquist/kenv.git ~/.kenv
npm run build-kit
The build command builds the SDK to ~/.kit
- 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
yarn webpack-dev
yarn install-electron-deps
yarn start
Assuming everything went well, the app should start up.