uomlibraryapps-card-scanner-hybrid-local/README.md

Library Node.js app for UoM card scanning (hybrid-local)

# Welcome to uomlibraryapps-card-scanner-hybrid-local 👋
![Version](https://img.shields.io/badge/version-0.0.1-blue.svg?cacheSeconds=2592000)
[![License: ISC](https://img.shields.io/badge/License-ISC-yellow.svg)](#)

> Library Node.js app for UoM card scanning (hybrid-local)

## Install

```sh
npm install uomlibraryapps-card-scanner-hybrid-local
```

The app will be installed into the node_modules folder of the current path. A local configuration file is needed before it can be run to set relative paths, see "Usage"

## Usage

A local configuration file must be created before running, in the folder "./config" called "uomlibraryapps-card-scanner.json" (NOT the node_modules/uomlibraryapps-card-scanner-hybrid-local/config, although this can be used as a template)

Crutially, the location of the Angular UI files needs to be set here.

```sh
{
	"ui": {
		"variation": "student"
	},
	"express": {
		"port": 8100
	},
	"angular": {
		"sourcePath": "./node_modules/uomlibraryapps-card-scanner-hybrid-local/angular"
	},
	"media": {
		"path": "/media/pi"
	},
	"database": {
		"dataPath": "./data"
	}
}
```

Then the application can be started from the current directory:

```sh
node node_module/uomlibraryapps-card-scanner-hybrid-local/dist/cli.js
```

## Author

👤 **UoM Library DTS**


## Show your support

Give a ⭐️ if this project helped you!


***
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_