sgamescz / hlidac-shopu

Hlídač shopů

Hlídač Shopů

PWA a rozšíření do nejrošířenějších prohlížečů, které zobrazuje historická data cen na největších českých a slovenských e-shopech vč. Reálné slevy.

---

PWA and browser extension shows historical prices for biggest czech and slovak e-commerce websites.

Install

• Chrome extension - also works in Edge, Brave and Opera
• Firefox extension
• Safari extension
• Progressive Web Application - app installable on most platforms
• iOS app - also works on iPadOS

Development

We are using package.json scripts (run yarn run for a list) for project automation.

Prerequisites

You will need:

• Node.js 16 (we use nvm for Node.js version management)
• yarn (we use Workspaces. You can't use npm. Sorry)
• Firefox
• Chrome
• XCode Command Line Tools (for Safari and iOS development)
• Pulumi (for Infrastructure and backend development)
• jq (for Extension distribution)

We have install scripts for Debian and macOS. See scripts folder for install scripts for your system.

On debian run bash ./scripts/install-debian-tools.sh - this will use apt-get to install jq. On macOS run bash ./scripts/install-macos-tools.sh - this will use homebrew to install jq, nvm and pulumi.

Step by step build of extension for reviewers

Make sure your system meets all prerequisites. See previous section.

nvm install $(< .nvmrc)
nvm use
yarn install
yarn build:extension
yarn build:firefox

Building extensions

All extensions (except Safari version) will be build to ./dist folder by calling the npm build script.

Firefox supports Dark and Light themes for action icons and we are optimising action icons for these. Chrome doesn't support action icons theming via manifest.json so we use background.js script to add support for themes programmatically. We are removing background.js script, and it's entry in manifest, in build step with other unnecessary files.

Content script content.js is written in ESM, but ESM is not widely supported in content scripts. So we use simple bundle script yarn build:extension to convert ESM to IIFE bundle.

Firefox extension

To build Firefox extension run yarn build:firefox. It will create extension-dist folder for development time and packaged extension in ./dist folder.

Chrome extension

To build Chrome extension run yarn build:chrome. It will create package in ./dist folder.

Safari extension

1. Run yarn build:safari to get latest bundle script, domains (eshops) permissions and current version for Safari
2. Distribute app by XCode: yarn start:safari > Product > Archive > Distribute App*
3. Manually send new app version to Review on Itunes Connect - you will need to be logged in as TopMonks developer (credentials in 1Password)

* Use autosigning feature and use the TopMonks s.r.o Apple developer team account. If this fails with missing private key, download one named "itunes Mac App Distribution mac_app.cer" from TopMonks 1Password.

Updating extension version

To check current version in package.json, manifest.json and about.html run

./version.sh

Update to new version run

./version.sh x.y.z

Extension development

For seamless development experience we have yarn watch:extension script with incremental builds on source files changes.

We also have convenient script yarn start:chrome and yarn start:firefox to start browsers with already registered extension and automatic reloading on changes.

For visual testing at scale, there is ./scripts/screenshotter.mjs. This will run Chrome with installed extension and take a screenshot of embedded widget on every supported e-shop. You can find resulting pictures in ./screenshots folder.

Other sources

• Figma design sources
• Apify Actors sources
• Keboola Connect

---

Update @hlidac-shopu/lib version for actors

1. Update version @hlidac-shopu/lib in ./lib/package.json
2. Publish package to npm. Ask @JanFiedler about login

    cd lib
    npm login
    npm publish --access public --tag latest

1. Update version @hlidac-shopu/lib in yarn.lock

yarn upgrade-interactive

© 2018-2021 TopMonks s.r.o.; Licensed under EPL-2.0