wallashss/libras

Translation service between a spoken and a signed language

Libras

Translation service between a spoken and a signed language.

Optionally, this application and all the different tests can be build and run in Docker.

Prerequisites

• Node.js

Setup

Install project dependencies:

npm install

Customize

Create an .env file to start the application in cluster mode, change its running port, log level, directory and maximum size. The variable names and default values are:

CLUSTER_MODE=false
PORT=3000
LOG_ENABLED=true
LOG_LEVEL=info
LOG_DIR=logs
LOG_MAX_SIZE=10m
LOG_MAX_FILES=7d

Run

Start the application:

npm start

Access localhost:3000/docs to check the API documentation.

Test

Run code style, unit, integration and security tests:

npm test

Code Coverage

Generate code coverage test report:

npm run cover

When reports are created, coverage/lcov-report/index.html can be opened in a web browser.

Performance Tests

Run performance tests:

npm run test:performance

When performance tests are completed, generate report:

npm run performance:report

logs/performance.log.html should open in a web browser.