Manual do Sistema VR PDV Admin API

Requisitos

• Docker
• Plugin Docker Compose

Instalação

1. Baixar os arquivos de configuração do aplicativo, LINK DE DOWNLOAD.

2. Extrair na pasta .vr, dentro da pasta padrão do usuário, os arquivos baixados.

 Estrutura da pasta
 ├── ./vr/
 │   ├── PdvAdmin/
 │   │   ├── .docker/ 
 │   │   │  └── postgres/ 
 │   │   │      ├── Dockerfile
 │   │   │      └── postgresql.conf
 │   │   ├── docker-compose.yml 
 └   └   └── .env

3. Configuração do ambiente pelo arquivo .env

 O Arquivo .env serve como central de configurações para o aplicativo, armazenando as variáveis de ambiente essenciais para o seu funcionamento. Essa prática garante maior flexibilidade e segurança, permitindo que você ajuste o comportamento do sistema sem a necessidade de modificar o código diretamente.
 -
 Principais Variáveis e suas Funcionalidades
 -
 PORT: Define a porta de comunicação com a interface do usuário (Front End).
 SOCKET_PORT: especifica a porta de comunicação com o ponto de venda (PDV).
 API_VERSION: indica a versão da API utilizada pelo sistema.
 IP: Define o endereço IP do servidor onde o aplicativo PDVAdmin está instalado.
 -
 GUI_VERSION: especifica a versão da interface gráfica do usuário.
 GUI_PORT: define a porta utilizada para acessar a interface gráfica através do navegador.
 -
 VRSOFT_PERMITE_CAMERAS: controla a habilitação do uso de câmeras. A configuração deve ser verificada com o cliente de acordo com o contrato.

4. Abrir o terminal na mesma pasta do arquivo docker-compose.yml e executar o comando:

 docker compose up --build

5. Com os serviços iniciados, acessar com o navegador conforme as configurações utilizadas em IP e GUI_PORT.

 Se tudo deu certo deve visualizar a tela de login para acesso ao aplicativo.