Egregious

A webapplication to scan products and send complaints about excess packaging.

Dev

Use the Node Version Manager (NVM) to install Node/NPM at the correct version:

nvm use

# if you get an error, install the project version of node then try again
nvm install 14.16

You can now generate a non-production build of the app

# build a dev build
npm run build:dev

# Start a local server
npm run server:start

At the moment, the only difference is how the frontend code is packaged. Prod builds are minified and don't include a source map; dev builds aren't and do.

Dev on mobile

Follow: https://developer.mozilla.org/en-US/docs/Tools/about:debugging

getUserMedia will fail without HTTPS, meaning no camera access.

To solve that use the docker-compose.dev.yml config to setup an nginx proxy that uses self signed certs.

sudo docker-compose -f ./docker-compose.yml -f ./docker-compose.dev.yml up --build

Connect to port 5001 via local network with HTTPS. It only listens for HTTP on localhost on 5000.

Auto rebuilds

Alternatively, you can use Nodemon to keep the builds building as you make changes.

HMR is a pain in the arse, so you'll have to refresh the page to load changes to the frontend right now.

npm run watch

See scripts in package.json.

Test

Server

# uses a bind-mount so the test setup can access the sqlite db file
# but because the app runs as a non-root user in the container
# the bind-mount folder needs to have the same uid as the user in the container
# this is more complicated if:
# 1) you're not running linux
# 2) Your host user does not have a user ID of 1000 (which is what user node has in the container)
# https://stackoverflow.com/a/29251160
mkdir egregiousdb
chown $USER egregiousdb
# rebuild app code, will be mapped to container by a bind-mount
npm run-script build
sudo docker-compose -f ./docker-compose.yml -f ./docker-compose.dev.yml up
sudo npm run-script test

Client

• open page

firefox http://localhost:5000

• allow webcam
• scan an EAN barcode (the ones on CDs)
• should appear in console logs

Production

We have an VPS instance running at 51.195.149.81. It runs the cheapest OVH instance.

It was provisioned as debian with docker installed. Additional manual configuration:

• sudo apt install docker-compose rsync
• Disabled password auth for ssh
  • In /etc/ssh/sshd_config:

    # PasswordAuthentication yes
    AuthenticationMethods publickey

The only user is the default debian

SSH access

Add you public key as a new line to ./scripts/public_keys and CI will copy to the instance when you merge to main. You can then access the instance as the debian user.

DB

We use sqllite with a volume mapped to persist it.

docker volume create egregiousdb

Back up and restore are based on Based on docker documentation

Backup

./scripts/backup.sh

Restore:

copy the backup file the remote host and then:

sudo docker run --rm -v egregiousdb:/egregiousdb -v $(pwd):/backup ubuntu bash -c "cd /egregiousdb && tar -xzf /backup/backup.tar --strip 1"

Deployment

This is done in CI with github actions using a private key stored in the repos secrets. See:

• .github/workflows/prod.yml
• ./scripts/deploy.sh

Testing CI

You can use (act)[https://github.com/nektos/act] to check the workflows are working.

# make sure the private key doesn't need decrypting or else it'll hang when trying to access it
# also this will do a real deploy, -n for dry run
sudo act -s DEPLOYMENT_SSH_KEY="myprivatekey"