Módulo de Login

# Instalação

# Baixando o Projeto


Clone o repositório dentro no diretório modules que deve existir na raiz do seu produto. Crie o diretório modules caso não exista.

git clone git@gitlab.teknisa.com:teknisa/login-next.git login

Atenção

O nome do diretório do módulo Login - Next deve ser login para que o mesmo funcione corretamente.

Atenção

Obs: Esses passos são para desenvolvimento.

Caso seu produto ainda esteja usando a versão 1.* da Tek-Lib, seu login deve estar na versão 1.5.3.

Execute o comando abaixo para que todas as tags fiquem disponíveis:

git fetch --tags

Depois, execute o comando abaixo para alterar para a tag da versão 1.5.3.

git checkout PROD_6138_1.5.3

# Dependências

# Backend


Em um terminal localizado em modules/login/backend, execute o comando:

composer install

# Frontend


Agora em modules/login/frontend, execute os comandos:

npm install
grunt

# Arquivos de Configuração


No ambiente de desenvolvimento é necessário criar arquivos de configuração para funcionamento do módulo. Por padrão, eles não existem porque cada desenvolvedor irá utilizar da forma que achar melhor (máquina local, cloud9, máquina Teknisa...).

  • Na pasta frontend crie o arquivo .env.development:

Dica

É possível copiar o .env.example como template.

A propriedade VUE_APP_DEV_SERVER_PORT deve ser definida com o valor da porta que o módulo irá utilizar em seu ambiente.

Atenção

No Cloud9 é necessário solicitar ao setor de redes a liberação das portas para utilizar em Produtos e Módulos Next.

Exemplo:

VUE_APP_PUBLIC_PATH=/
VUE_APP_DEV_SERVER_PORT=8081

  • Na pasta frontend/src/config crie o arquivo devEnvironment.json:

Dica

É possível copiar o devEnvironment.example como template.

A propriedade endPoint deve ser definida com o endereço HTTP do backend do módulo até o index.php
A propriedade metadataEndPoint deve ser definida com o endereço HTTP do backend do módulo até a rota lib_metadata

Exemplo:

{
	"endPoint": "http://localhost/seu_produto/modules/login/backend/service/index.php",
	"metadataEndPoint": "http://localhost/seu_produto/modules/login/backend/service/index.php/lib_metadata/"
}

# Configurações no Produto


  • Defina as propriedades relacionadas ao Login, juntamente com as configurações dos demais módulos, no arquivo seu_produto/frontend/src/config/devEnvironment.json.
    • baseUrl: indica qual URL o módulo é acessado.
    • routePath: deve ter o valor /auth/login.
      • Caso seu produto ainda utilize a versão 1.* da Tek-Lib, o valor deve ser /modules/login/autenticacao.
    • backgroundImgUrl: indica para o módulo o endereço da imagem de background que deve ser carregada na tela de login.
    • endPoint: indica para o produto qual o backend do módulo em questão.

Atenção

O módulo não irá funcionar sem realizar as configurações do produto!

Exemplo:

...
"modules": {
	"login": {
		"baseUrl": "http://localhost:8081",
		"routePath": "/auth/login",
		"backgroundImgUrl": "http://localhost:8080/assets/img/teknisa-login-background.jpg",
		"endPoint": "http://localhost/seu_produto/modules/login/backend/service/index.php"
	},
}

# Executando o Módulo


Para acessar as telas do Login, abra um terminal na pasta frontend do módulo e execute:

npm run serve

Atenção

O módulo não funciona sozinho. É necessário que o produto também esteja em execução.

Dica

Se estiver utilizando a versão 2.* da Tek-Lib for acessar apenas a tela de Login para autenticar no seu produto, não há a necessidade de executar o módulo. Mas, na versão 1.* é necessário.