Getting Started

Requirements For Development

• Chrome and Firefox installed on your machine
• Yarn (https://yarnpkg.com/lang/en/docs/install/)
• Any IDE of your choice that can support Prettier and ESLint
  • VSCode users:
    • Integration with Prettier (VSCode Plugin)
    • Integration with ESLint (VSCode Plugin)

Download Saka

Run the following commands in your terminal to clone Saka:

git clone https://github.com/lusakasa/saka.git;
cd saka;
yarn install;

Build Saka

Chrome

1. Run the following commands in your terminal to build Saka. An extension you can run will be generated in the dist directory.

   yarn run build:chrome;
   # or if you want to generate an optimized production build
   yarn run build:chrome:prod;

2. Navigate to chrome://extensions
3. Enable developer mode and click Load Unpacked Extension
4. Select the dist directory, and 🚀.
5. Refresh existing tabs to load Saka into them

Firefox

1. Run the following commands in your terminal to build Saka. An extension you can run will be generated in the dist directory.

   yarn run build:firefox;
   # or if you want to generate an optimized production build
   yarn run build:firefox:prod;

2. Navigate to about:debugging
3. Enable add-on debugging and click Load Temporary Add-on
4. Select any file within the dist directory, and 🚀.
5. Firefox will load Saka automatically into all valid existing tabs

Running Tests

We use Jest and the dom-testing-library to test Saka. To run the tests you can simply run yarn test in your terminal and you should see Jest output something like this:

Most of the time you want Jest to automatically run whenever there are changes to any of the code or tests. To do this run yarn test:watch in your terminal and Jest should automatically run when there are changes.