BenSDK 🚀

O BenSDK CLI é uma ferramenta de linha de comando que auxilia no desenvolvimento de projetos que são executados dentro do Integrador Benup. Ele simplifica o processo de criação e gerenciamento dos módulos que se integram ao ecossistema Benup.

📋 O que é o BenSDK?

O BenSDK é um framework para a criação de integrações entre benefícios e o ecossistema Benup.

✨ Funcionalidades Principais

• 🚀 Geração de projetos benApp
• ⚡ Configuração automática do ambiente de desenvolvimento
• 📦 Suporte a TypeScript
• 🎯 Interface de linha de comando

🛠️ Instalação

Instale o BenSDK CLI globalmente via npm:

npm i -g @benup/bensdk

Após a instalação, o CLI estará disponível através do comando ben:

Usage: BenSDK Tool [options] [command]

CLI to create benefits integration

Options:
  -V, --version     output the version number
  -h, --help        display help for command

Commands:
  init <string>     New project
  help [command]    display help for command

🚀 Uso

Para criar um novo projeto benApp:

ben init <NOME-DO-BENEFICIO>

Após criar o projeto:

1. Abra o projeto gerado no seu editor de preferência
2. Execute o comando para gerar os handlers baseados na máquina de estado:

   npm run generate

3. Para rodar a integração localmente:

   npm run start

📦 Publicação

1. Instale o maria-cli seguindo as instruções do repositório.
2. Execute o comando abaixo na raiz do projeto:

maria benefit deploy -r <link-de-clone-do-repositorio.git> -n <BENEFIT-ID>

📁 Estrutura do Projeto

O projeto gerado inclui:

• ⚙️ Configuração TypeScript
• 📦 Estrutura básica para criação do módulo
• 📚 Dependências necessárias
• 🖼️ Simulador do Integrador para desenvolvimento local
• 🔄 Geração automática de handlers baseado na máquina de estado

📦 Dependências

• Node.js
• TypeScript
• Várias bibliotecas de desenvolvimento

📝 Scripts Disponíveis

• ben init <NOME-DO-BENEFICIO>: Cria um novo projeto benApp
• npm run generate: Gera os handlers baseados na máquina de estado
• npm run start: Inicia a integração localmente

📚 Documentação

Para mais informações sobre o BenSDK e o Integrador, consulte a documentação oficial.