LabTrail

QR-code manager with multi-tenant support.

This project is sponsored by the bioprocess technology division of the ZHAW.

LabTrail is the central platform to manage the destinations of QR-Codes. Register new QR-Codes and define multiple link targets. Manage users and assign them to tenants. Switch easily between tenants and their active QR-Code category.

Demo

Open https://labtrail.app/ in your browser and login with username [email protected] and password demo.

Configuration

Database

For search performance text indexes are required on every mongodb collection. Index the following fields:

categories.name
documents.title
tenants.name
stations.name
user.firstname
user.lastname
user.email

Environment Variables

.env

MONGODB_URI=mongodb://USERNAME:PASSWORD@URL:PORT/DATABASENAME
JWT_SECRET=SECRET_KEY
# Docker deployment:
API_VERSION=X.X.X
APP_VERSION=X.X.X
QR_VERSION=X.X.X
REGISTRY=URI

Checkout each packagefolder for environment variable definitions.

Development

Install package dependencies with yarn workspace.

yarn

Run the development server.

yarn dev

Package

Every package can be developed standalone.

Configure the package environment variables and start the development server.

yarn dev

Testing

Run the linter first.

yarn lint

Configure the package environment variables and then run the tests.

yarn test

Deployment

Serverless

Configure the environment variables and deploy with now.

now

Docker

Configure the environment variables for docker and build the images.

yarn docker-build-api
yarn docker-build-app
yarn docker-build-qr

Run docker compose to test.

yarn docker-compose

Tag images.

yarn docker-tag-api
yarn docker-tag-app
yarn docker-tag-qr

Publish images to registry.

yarn docker-publish-api
yarn docker-publish-app
yarn docker-publish-qr

Pull images from registry.

yarn docker-pull-api
yarn docker-pull-app
yarn docker-pull-qr