This repository has been archived by the owner on Apr 27, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 20
Getting Started
Uzair Shamim edited this page Aug 18, 2018
·
10 revisions
- 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)
- VSCode users:
Run the following commands in your terminal to clone Saka:
git clone https://github.com/lusakasa/saka.git;
cd saka;
yarn install;
- 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;
- Navigate to
chrome:https://extensions
- Enable developer mode and click
Load Unpacked Extension
- Select the
dist
directory, and 🚀. - Refresh existing tabs to load Saka into them
- 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;
- 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 automatically into all valid existing tabs
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.