ame-super-app-web

ame-super-app-web

API de suporte para super-app sites da Ame

O que é esse projeto?

O ame-super-app-web é a biblioteca que permite tornar um site, que chamaremos de target, em um ambiente capaz de executar mini-apps construídos com a plataforma de mini-apps web da Ame.

Um target que deseje adotar a plataforma de mini-apps web da Ame, deve instalar esse pacote e seguir os passos descritos nesse manual a seguir.

Como utilizar?

Para utilizar esse pacote é necessário executar dois passos:

1. Invocar a função de inicialização da lib Ame.init() num ponto de entrada/configuração do site
2. Criar uma rota/página na qual o mini-app será exibido.

Inicialização da lib

Em algum momento no início do ciclo de vida da aplicação (recomendado: No index da aplicação ou equivalente) a função Ame.init deve ser chamada.

Parâmetros obrigatórios:

environment

Os valores suportados são de "dev", "hml" ou "prod", de acordo com o ambiente da aplicação.

O enum SuperAppEnvironment também pode ser utilizado.

url

Endereço principal do site onde a plataforma está instalada. Ex: "https://www.amedigital.com"

target

• Identifica qual sistema está rodando a plataforma de mini-apps.
• Essa configuração permite escolher os mini-apps adequados ao sistema que está sendo executado.
• Novos targets precisam de um setup prévio para funcionar adequadamente.
• Entre em contato para avaliarmos a criação de um novo target.

Código de exemplo

Para rodar o projeto de exemplo basta seguir os seguintes passos:

1. rodar o comando npm run example
2. acessar o diretório ./ame-super-app-web/example/ame-super-app-web-example