Lazztech.Hub-Service

Companion Mobile App

For the companion mobile app client see the repo linked below.

Lazztech.Hub-App

Development Dependencies

Development tools:

• brew
  • https://brew.sh/
  • postgres
• docker
• node version manager
  • https://github.com/nvm-sh/nvm

# use nvm to install node from the .nvmrc file
$ nvm install
# set the in use node version from the .nvmrc file's verision
$ nvm use
# install node dependencies
$ npm install

# if you run into an issue installing sharp on apple M1 see the link below:
# https://github.com/lovell/sharp/issues/2460#issuecomment-751491241 

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Kubernetes

# deploy local secrets
$ kubectl create secret generic local-lazztechhub --from-env-file=.env.local
# deploy local
$ kubectl apply -f kubernetes/local.yaml

# open graphql-playground
$ open http://localhost:30000/graphql

# delete local
$ kubectl delete -f kubernetes/local.yaml
# delete local secrets
$ kubectl delete secret local-lazztechhub

# deploy dev secrets
$ kubectl create secret generic dev-lazztechhub --from-env-file=.env.dev
# deploy dev
$ kubectl apply -f kubernetes/dev.yaml

# delete dev
$ kubectl delete -f kubernetes/dev.yaml
# delete dev secrets
$ kubectl delete secret dev-lazztechhub

# deploy stage secrets
$ kubectl create secret generic stage-lazztechhub --from-env-file=.env.stage
# deploy stage
$ kubectl apply -f kubernetes/stage.yaml

# delete stage
$ kubectl delete -f kubernetes/stage.yaml
# delete stage secrets
$ kubectl delete secret stage-lazztechhub

Postgres

A local instance of postgres running in a docker container for testing against a prod DB replica. Pgadmin is not required, but recommend for ease of use. Alternatively the database-client VSCode extension may be used.

• https://marketplace.visualstudio.com/items?itemName=cweijan.vscode-database-client2

Create database dump and import to local database

# prepare gitignored data folder if it's not already present
$ mkdir ./data

# dump database
$ pg_dump -h <host> -p <port> -U <username> -Fc <database> > ./data/db.dump

# start postgres
$ docker run --name lazztech_postgres -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=Password123 -e POSTGRES_DB=postgres -p 5432:5432 postgres

# copy dump file to the docker container
$ docker cp ./data/db.dump lazztech_postgres:/var/lib/postgresql/data/db.dump

# shell into container
$ docker exec -it lazztech_postgres bash

# restore it from within
$ pg_restore -U postgres -d postgres --no-owner -1 /var/lib/postgresql/data/db.dump

# cleanup
$ docker stop lazztech_postgres
$ docker rm lazztech_postgres

In your .env or .env.local file configure these enviroment varaibles for postgres

# Postgres
DATABASE_TYPE=postgres
DATABASE_SCHEMA=postgres
DATABASE_HOST=localhost
DATABASE_PORT=5432
DATABASE_USER=postgres
DATABASE_PASS=Password123
DATABASE_SSL=false

# docker-compose.yml
version: '3.8'
services:
  db:
    container_name: lazztech_postgres
    image: postgres
    restart: always
    ports:
      - '5432:5432'
    environment:
      - POSTGRES_USER=postgres
      - POSTGRES_PASSWORD=Password123
      - POSTGRES_DB=postgres
    volumes:
      - /<Your_Volume_Directory>
  pgadmin:
    container_name: pgadmin4
    image: dpage/pgadmin4
    restart: always
    environment:
      - PGADMIN_DEFAULT_EMAIL=admin@admin.com
      - PGADMIN_DEFAULT_PASSWORD=root
    ports:
      - '5050:80'

Migrations

Migrations are managed via the mikro-orm CLI.

Config values are available via the following:

# Note: due to configuration differences, run build before generating sqlite migrations!

# Create a Sqlite Migration
$ npx mikro-orm migration:create --config mikro-orm.sqlite.cli-config.ts

# Create a Postgresql Migration
$ npx mikro-orm migration:create --config mikro-orm.postgres.cli-config.ts

$ npx mikro-orm
Usage: mikro-orm <command> [options]

Commands:
  mikro-orm cache:clear             Clear metadata cache
  mikro-orm cache:generate          Generate metadata cache
  mikro-orm generate-entities       Generate entities based on current database
                                    schema
  mikro-orm database:create         Create your database if it does not exist
  mikro-orm database:import <file>  Imports the SQL file to the database
  mikro-orm seeder:run              Seed the database using the seeder class
  mikro-orm seeder:create <seeder>  Create a new seeder class
  mikro-orm schema:create           Create database schema based on current
                                    metadata
  mikro-orm schema:drop             Drop database schema based on current
                                    metadata
  mikro-orm schema:update           Update database schema based on current
                                    metadata
  mikro-orm schema:fresh            Drop and recreate database schema based on
                                    current metadata
  mikro-orm migration:create        Create new migration with current schema
                                    diff
  mikro-orm migration:up            Migrate up to the latest version
  mikro-orm migration:down          Migrate one step down
  mikro-orm migration:list          List all executed migrations
  mikro-orm migration:check         Check if migrations are needed. Useful for
                                    bash scripts.
  mikro-orm migration:pending       List all pending migrations
  mikro-orm migration:fresh         Clear the database and rerun all migrations
  mikro-orm debug                   Debug CLI configuration

Options:
      --config                  Set path to the ORM configuration file   [array]
      --contextName, --context  Set name of config to load out of the ORM
                                configuration file. Used when config file
                                exports an array or a function
                                                   [string] [default: "default"]
  -v, --version                 Show version number                    [boolean]
  -h, --help                    Show help                              [boolean]

Examples:
  mikro-orm schema:update --run  Runs schema synchronization

Web Push Notifications

# generate public and private vapid keys
$ npx web-push generate-vapid-keys

Scripts

# test, build & push container, deploy dev and deploy stage
# note: the buildTagAndPushDocker.sh uses docker buildx for m1 support to cross compile to x86
$ ./scripts/preCommit.sh && ./scripts/buildTagAndPushDocker.sh && ./scripts/deployToDev.sh && ./scripts/deployToStage.sh

Configuration

Parameter	Function	Optional	Example
APP_NAME	Used when sending emails to call out the name of the service	❌	Lazztech Hub
ACCESS_TOKEN_SECRET	Used for jwt tokens	❌
PUBLIC_VAPID_KEY	Used for web push notifications	✅
PRIVATE_VAPID_KEY	Used for web push notifications	✅
FIREBASE_SERVER_KEY	Used for push notifications	❌
PUSH_NOTIFICATION_ENDPOINT	Used for triggering push notifications via http	❌
EMAIL_TRANSPORT	Used for emailing users	✅	'gmail' or 'mailgun' defaults to gmail
EMAIL_API_KEY	Used for emailing users	required for mailgun
EMAIL_DOMAIN	Used for emailing users	required for mailgun
EMAIL_FROM_ADDRESS	Used for emailing users	❌
EMAIL_PASSWORD	Used for emailing users	✅ when transport is mailgun
DATABASE_TYPE	Used for selecting sqlite or postgres	Defaults to sqlite ✅	'sqlite' or 'postgres'
DATABASE_HOST	Used for connecting to database	Optional depending on database type ✅
DATABASE_PORT	Used for connecting to database	Optional depending on database type ✅
DATABASE_USER	Used for connecting to database	Optional depending on database type ✅
DATABASE_PASS	Used for connecting to database	Optional depending on database type ✅
DATABASE_SCHEMA	Used for connecting to database	Optional depending on database type ✅
DATABASE_SSL	To configure whether to use SSL for database	Optional depending on database type ✅
FILE_STORAGE_TYPE	For selecting local or S3 compatible storage configuration	Defaults to local ✅	Select 'local' or 'object'
OBJECT_STORAGE_ACCESS_KEY_ID	Used for S3 compatible object file storage	Optional depending on file storage type ✅
OBJECT_STORAGE_SECRET_ACCESS_KEY	Used for S3 compatible object file storage	Optional depending on file storage type ✅
OBJECT_STORAGE_ENDPOINT	Used for S3 compatible object file storage	Optional depending on file storage type ✅

Stay in touch

• Website - https://lazz.tech/

License

Copyright Lazztech LLC