VLibras Cross Platform App Developer Guide

Development guide for the VLibras Cross Platform App covering its architecture, Ionic plugins, prerequisites and Android emulator testing.


VLibras Cross Platform App Developer Guide - cover page
Brand
VLibras
Category
Application program
Document type
Programming Manual
Language
Portuguese
Pages
11
File format
PDF
File size
1.3 MB
Published
17 November, 2026
Updated
17 November, 2026
MD5 checksum
918E7887EBC0739AD9FA0EBE06AAD63D

About this manual

This document is a development guide for the VLibras Cross Platform App. It presents a general introduction to the application, a short description, its architecture, a test and environment preparation manual. The app was developed with Ionic 5 React (TypeScript) for automatic translation of Portuguese into LIBRAS on iOS and Android platforms, aiming to help the inclusion of deaf people and to encourage learning of Brazilian Sign Language.

The architecture section explains the purpose of each project directory, from src, config and assets to components, pages, routes, store, themes and services, including the Axios configuration used for HTTP requests to the Vlibras dictionary API. The test section lists the Ionic plugins used, the prerequisites Yarn, Ionic, NodeJS and Android Studio, and the steps for running the app in the Android emulator. This manual is written in Portuguese.

What's inside

  • Introdução
  • Breve descrição
  • Arquitetura
  • Estrutura de diretórios (src, config, assets, components, pages, services)
  • Plugins do Ionic
  • Manual de testes e preparação de ambiente
  • Sistemas Operacionais
  • Pré-requisitos
  • Versão Android
  • Execução via Android Emulator

Specifications

Development technologyIonic 5 React (TypeScript)
Supported platformsiOS and Android
Default dictionary API addresshttps://dicionario2-dth.vlibras.gov.br/api
Operating systems for developmentWindows, Linux or macOS
Required Yarn version1.22.10
Required Ionic version6.16.3
Required NodeJS version14.16.0
Required Android Studio version4.1

Frequently asked questions

What technology is the VLibras Cross Platform App built with?

It was developed using Ionic 5 React (TypeScript) for automatic translation of Portuguese into LIBRAS on iOS and Android.

Which operating systems can be used to develop the app?

Any of the main operating systems, Windows, Linux or macOS. A Linux distribution is recommended because installing the dependencies is simpler.

How do I install the app dependencies?

Clone the VLibras Cross Platform App repository and, inside the project folder terminal, install the app with npm install or yarn install.

How do I enable the video translator feature?

Change the videoTranslator flag to true in src/environment/env.ts.

Download PDF (1.3 MB)