@benup/bensdk 1.12.1 → 1.12.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +34 -15
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# BenSDK 🚀
|
|
2
2
|
|
|
3
3
|
<div align="center">
|
|
4
|
-
<img src="https://img.shields.io/badge/Status-
|
|
5
|
-
<img src="https://img.shields.io/badge/Version-1.
|
|
4
|
+
<img src="https://img.shields.io/badge/Status-Stable-green" alt="Status: Stable">
|
|
5
|
+
<img src="https://img.shields.io/badge/Version-1.12.1-blue" alt="Version: 1.12.1">
|
|
6
6
|
</div>
|
|
7
7
|
|
|
8
8
|
<br>
|
|
@@ -24,35 +24,54 @@ O BenSDK é um framework para a criação de integrações entre benefícios e o
|
|
|
24
24
|
- 📦 Suporte a TypeScript
|
|
25
25
|
- 🎯 Interface de linha de comando
|
|
26
26
|
|
|
27
|
-
## 🛠️ Instalação
|
|
28
|
-
|
|
29
|
-
Como o projeto ainda está em fase de testes internos, você precisará clonar o repositório:
|
|
27
|
+
## 🛠️ Instalação
|
|
30
28
|
|
|
29
|
+
Instale o BenSDK CLI globalmente via npm:
|
|
31
30
|
```bash
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
31
|
+
npm i -g @benup/bensdk
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Após a instalação, o CLI estará disponível através do comando `ben`:
|
|
35
|
+
```
|
|
36
|
+
Usage: BenSDK Tool [options] [command]
|
|
37
|
+
|
|
38
|
+
CLI to create benefits integration
|
|
39
|
+
|
|
40
|
+
Options:
|
|
41
|
+
-V, --version output the version number
|
|
42
|
+
-h, --help display help for command
|
|
43
|
+
|
|
44
|
+
Commands:
|
|
45
|
+
init <string> New project
|
|
46
|
+
help [command] display help for command
|
|
35
47
|
```
|
|
36
48
|
|
|
37
49
|
## 🚀 Uso
|
|
38
50
|
|
|
39
51
|
Para criar um novo projeto benApp:
|
|
40
|
-
|
|
41
52
|
```bash
|
|
42
|
-
|
|
53
|
+
ben init <NOME-DO-BENEFICIO>
|
|
43
54
|
```
|
|
44
55
|
|
|
45
56
|
Após criar o projeto:
|
|
46
57
|
|
|
47
58
|
1. Abra o projeto gerado no seu editor de preferência
|
|
48
59
|
2. Execute o comando para gerar os handlers baseados na máquina de estado:
|
|
49
|
-
|
|
60
|
+
```bash
|
|
50
61
|
npm run generate
|
|
51
|
-
|
|
62
|
+
```
|
|
52
63
|
3. Para rodar a integração localmente:
|
|
53
|
-
|
|
64
|
+
```bash
|
|
54
65
|
npm run start
|
|
55
|
-
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## 📦 Publicação
|
|
69
|
+
|
|
70
|
+
1. Instale o [maria-cli](https://github.com/benup-dev/maria) seguindo as instruções do repositório.
|
|
71
|
+
2. Execute o comando abaixo na raiz do projeto:
|
|
72
|
+
```bash
|
|
73
|
+
maria benefit deploy -r <link-de-clone-do-repositorio.git> -n <BENEFIT-ID>
|
|
74
|
+
```
|
|
56
75
|
|
|
57
76
|
## 📁 Estrutura do Projeto
|
|
58
77
|
|
|
@@ -72,7 +91,7 @@ O projeto gerado inclui:
|
|
|
72
91
|
|
|
73
92
|
## 📝 Scripts Disponíveis
|
|
74
93
|
|
|
75
|
-
- `
|
|
94
|
+
- `ben init <NOME-DO-BENEFICIO>`: Cria um novo projeto benApp
|
|
76
95
|
- `npm run generate`: Gera os handlers baseados na máquina de estado
|
|
77
96
|
- `npm run start`: Inicia a integração localmente
|
|
78
97
|
|