Jaiminho Notifications

O Jaiminho Notifications é uma abstração para a implementação de canais de comunicação por mensagens, projetada para facilitar a integração de notificações em aplicações web e mobile.

Para desenvolvedores

Pré-requisitos

Antes de começar, certifique-se de ter as seguintes dependências instaladas:

• nvm
• Node v18+
• Yarn

Configuração do Ambiente

Definindo a Versão do Node.js. O projeto utiliza uma versão específica do Node.js, definida no arquivo .nvmrc. Para configurar a versão correta, execute o comando abaixo:

nvm use 20

Observação: Esse comando requer que o nvm esteja instalado globalmente no seu sistema.

Configuração do Token de Acesso ao GitLab

Se este for o primeiro projeto com dependências privadas que você está utilizando, será necessário configurar um token de acesso ao GitLab para instalar os pacotes privados. Siga os passos abaixo:

• Gere um Access Token no GitLab.
• Execute o seguinte comando na raiz do projeto para configurar o arquivo .npmrc:

echo "@sanardigital:registry=https://gitlab.com/api/v4/packages/npm/
//gitlab.com/api/v4/packages/npm/:_authToken=${GITLAB_TOKEN}
//gitlab.com/api/v4/projects/:_authToken=${GITLAB_TOKEN}
" >> .npmrc

Substitua ${GITLAB_TOKEN} pelo token que você gerou. Se o arquivo .npmrc já estiver configurado, você pode pular essa etapa.

Instalação das Dependências

Após configurar a versão do Node.js e o token de acesso, instale as dependências do projeto utilizando um dos comandos abaixo:

yarn install

npm install

Implementação da Biblioteca

Web

Mobile