DEVELOPMENT.md

Development

This document describes the process for running this application on your local computer.

Getting Started

1. Clone the repo

   git clone https://github.com/quaric/zadark.git
   cd zadark

2. Install packages

   yarn install

3. Start development

   yarn dev
   
   # or build
   yarn build
   
   # ➜ Output:
   # build/
   #   chrome/
   #     manifest.json
   #     ...
   #   edge/
   #     manifest.json
   #     ...
   #   firefox/
   #     manifest.json
   #     ...
   #   pc/
   #     package.json
   #     index.js
   #     ...

4. Testing

• macOS & Windows
  • yarn run pc:dev
• Chrome Extension
  • Step 1: Open chrome://extensions/
  • Step 2: Turn on Developer Mode
  • Step 3: Click Load unpacked
  • Step 4: Choose folder build/chrome/
• Safari Extension
  • Step 1: Open src/web/vendor/safari/ZaDark.xcodeproj in Xcode
  • Step 2: Choose Product > Run
  • Step 3: Open Safari > Preferences > Extensions > Turn on ZaDark for Safari
• Edge Extension
  • Step 1: Open edge://extensions/
  • Step 2: Turn on Developer Mode
  • Step 3: Click Load unpacked
  • Step 4: Choose folder build/edge/
• Firefox Extension
  • Step 1: Open about:debugging#/runtime/this-firefox
  • Step 2: Click Load Temporary Add-on...
  • Step 3: Choose file build/firefox/manifest.json

Creating Built Distributions

For Safari Extension

1. Run yarn build
2. Run yarn safari or open src/web/vendor/safari/ZaDark.xcodeproj in Xcode
3. Choose Product > Archive

Documentation: https://developer.apple.com/documentation/xcode/distributing-your-app-for-beta-testing-and-releases

For Other Platforms

# Create a signing key pair (https://developer.chrome.com/docs/webstore/update#protect-package-updates)
openssl genrsa -out ./certs/privatekey.pem 2048

yarn dist

# ➜ Output:
# dist/
#   zadark[VERSION]-chrome.zip
#   zadark[VERSION]-chrome.crx
#   zadark[VERSION]-edge.zip
#   zadark[VERSION]-firefox.zip
#   zadark[VERSION]-windows.zip
#   zadark[VERSION]-macos-arm64.zip
#   zadark[VERSION]-macos-x64.zip

• For Chrome, Edge and Firefox: Distribute dist/zadark[VERSION]-[PLATFORM].zip to Store
  • Protect your package updates: https://developer.chrome.com/docs/webstore/update#protect-package-updates
• For Windows: Distribute dist/zadark[VERSION]-windows.zip directly to users
• For macOS: Distribute dist/zadark[VERSION]-macos-[ARCH].zip directly to users