Skip to content

Commit 12f05c6

Browse files
chore: work in update starter
1 parent 67411e7 commit 12f05c6

24 files changed

+159
-127
lines changed
File renamed without changes.

.github/ISSUE_TEMPLATE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
Make sure these boxes are checked before submitting your issue -- thank you!
22

33
- [ ] You are using NodeJs 10 or higher
4-
- [ ] You have installed all dependencies and tools listed in here. [📝 Basic requirements](https://github.com/rudemex/fb-messenger-bot#basic-requirements)
4+
- [ ] You have installed all dependencies and tools listed in here. [📝 Basic requirements](https://github.com/rudemex/node-typescript-express-starter#basic-requirements)
55
- [ ] You have checked if someone has already asked the same issue you have.
6-
- [ ] You have read the [documentation](https://github.com/rudemex/fb-messenger-bot#readme).
6+
- [ ] You have read the [documentation](https://github.com/rudemex/node-typescript-express-starter#readme).
77
- [ ] Is not a programming question.
88
- [ ] You are using latest code of Starter Kit for the creation of bots for Facebook Messenger and Workplace.
99

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ assignees: ''
1010
Make sure these boxes are checked before submitting your issue -- thank you!
1111

1212
- [ ] You are using NodeJs 10 or higher
13-
- [ ] You have installed all dependencies and tools listed in here. [📝 Basic requirements](https://github.com/rudemex/fb-messenger-bot#basic-requirements)
13+
- [ ] You have installed all dependencies and tools listed in here. [📝 Basic requirements](https://github.com/rudemex/node-typescript-express-starter#basic-requirements)
1414
- [ ] You have checked if someone has already asked the same issue you have.
15-
- [ ] You have read the [documentation](https://github.com/rudemex/fb-messenger-bot#readme).
15+
- [ ] You have read the [documentation](https://github.com/rudemex/node-typescript-express-starter#readme).
1616
- [ ] Is not a programming question.
1717
- [ ] You are using latest code of Starter Kit for the creation of bots for Facebook Messenger and Workplace.
1818

.github/workflows/build.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ jobs:
3333
run: npm install
3434
- name: "🔦 Lint"
3535
run: npm run lint
36-
- name: "👨‍💻 Run Test and generate coverage report"
37-
run: npm run test -- --coverage
36+
- name: "🔨 Build"
37+
run: npm run build
38+
- name: "👨‍💻 Run Test"
39+
run: npm run test
3840
- name: "📊 Upload coverage report to Codecov"
3941
uses: codecov/codecov-action@v1
4042
with:
4143
token: ${{ secrets.CODECOV_TOKEN }}
42-
- name: "🔨 Build"
43-
run: npm run build

.github/workflows/test.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,10 @@ jobs:
3333
run: npm install
3434
- name: "🔦 Lint"
3535
run: npm run lint
36-
- name: "👨‍💻 Run Test and generate coverage report"
37-
run: npm run test -- --coverage
36+
- name: "🔨 Build"
37+
run: npm run build
38+
- name: "👨‍💻 Run Test"
39+
run: npm run test
3840
- name: "📊 Upload coverage report to Codecov"
3941
uses: codecov/codecov-action@v1
4042
with:

CONTRIBUTING.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
## Glosario
2424

2525
- [📝 Requerimientos básicos](#basic-requirements)
26-
- [🛠 Instalar dependencias](#install-dependencies)
26+
- [🛠 Instalar dependencias](#install-dependencies)
2727
- [⚙️ Configuración](#configurations)
2828
- [💻 Scripts](#scripts)
2929
- [📚 Swagger](#swagger-info)
@@ -85,6 +85,7 @@ esquema.
8585
"enabledLogs": "true"
8686
},
8787
"swagger": {
88+
"path":'api-docs',
8889
"enabled": "true"
8990
},
9091
"params": {
@@ -150,7 +151,6 @@ servidor. [Lista de zonas horarias](https://en.wikipedia.org/wiki/List_of_tz_dat
150151
- Type: `String`
151152
- Default: `America/Argentina/Buenos_Aires`
152153

153-
154154
`showLogInterceptor`: Habilita o deshabilita la visualización de los interceptors de los requests y responses por medio de logs.
155155

156156
- Type: `Boolean`
@@ -163,6 +163,11 @@ servidor. [Lista de zonas horarias](https://en.wikipedia.org/wiki/List_of_tz_dat
163163

164164
#### Swagger
165165

166+
`path`: Define la ruta de la documentación **Swagger**, se escribe sin el `/` (slash).
167+
168+
- Type: `String`
169+
- Default: `api-docs`
170+
166171
`enabled`: Habilitar o deshabilitar la documentación **Swagger** de los endpoints del servidor.
167172

168173
- Type: `Boolean`
@@ -234,6 +239,14 @@ Inicia la aplicación de transpilada de la carpeta `./dist`, se requiere previam
234239
npm run start
235240
```
236241

242+
#### Test
243+
244+
Inicia la fake app para correr los unit test con **Jest** y retorna el coverage.
245+
246+
```
247+
npm run test
248+
```
249+
237250
<a name="swagger-info"></a>
238251

239252
## 📚 Swagger
@@ -250,6 +263,7 @@ Esta documentación puede ser activada o desactivada desde el archivo de configu
250263
{
251264
...
252265
"swagger": {
266+
"path": 'api-docs',
253267
"enabled": "true"
254268
},
255269
...
@@ -258,6 +272,7 @@ Esta documentación puede ser activada o desactivada desde el archivo de configu
258272

259273
```js
260274
// ENV
275+
SWAGGER_PATH=api-docs
261276
SWAGGER_ENABLED=true;
262277
```
263278

config/custom-environment-variables.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
"enabledLogs": "ENABLED_LOGS"
1414
},
1515
"swagger": {
16+
"path": "SWAGGER_PATH",
1617
"enabled": "SWAGGER_ENABLED"
1718
},
1819
"params": {

config/development.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
"enabledLogs": "true"
1414
},
1515
"swagger": {
16+
"path": "api-docs",
1617
"enabled": "true"
1718
},
1819
"params": {

config/test.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
"enabledLogs": "false"
1414
},
1515
"swagger": {
16+
"path": "api-docs",
1617
"enabled": "false"
1718
},
1819
"params": {

0 commit comments

Comments
 (0)