Setup
Requirements
To develop Saka Key, you must first install:
- Git
- Node.js and npm
- A text editor. I recommend VS Code with the ESLint and Prettier extensions.
Install
Install on Chrome
- Run the following commands in your terminal to clone and build Saka Key. An extension you can run will be generated in the 'dist' directory.
git clone https://github.com/lusakasa/saka-key.git
cd saka-key
npm install
npm run start:chrome
# or if you want to generate an optimized production build
npm run build:chrome
Navigate to
chrome://extensions
Enable developer mode and click 'Load Unpacked Extension'
Select the dist directory, and ๐.
Refresh existing tabs to load Saka Key into them
Install on Firefox
- Run the following commands in your terminal to clone and build Saka Key. An extension you can run will be generated in the 'dist' directory.
git clone https://github.com/lusakasa/saka-key.git
cd saka-key
npm install
npm run start:firefox
# or if you want to generate an optimized production build
npm run build:firefox
Navigate to
about:debugging
Enable add-on debugging and click 'Load Temporary Add-on'
Select any file within the dist directory, and ๐.
Firefox will load Saka Key automatically into all valid existing tabs
Development Tips
Saka Key is developed together with:
You may have to debug or modify Mosi when contributing to saka key. To use your local copy of Mosi when building Saka Key:
- Navigate to Mosi's root directories.
- Run
npm link
- Navigate to the root of Saka key.
- Run
npm link mosi
Deployment
A Github action generates a release from every tagged commit. To generate a new release, run git tag vx.x.x"
. Then push the tag withgit push origin vx.x.x
.
key.saka.io is automataically generated from /docs
directory of Saka Key's github repository on every commit using Netlify.
Testing
This is unfortunately a todo.