Skip to content

Commit 17dc35f

Browse files
committed
changed readme
1 parent 9db63ce commit 17dc35f

File tree

1 file changed

+3
-9
lines changed

1 file changed

+3
-9
lines changed

generators/app/templates/_README.md

+3-9
Original file line numberDiff line numberDiff line change
@@ -91,10 +91,9 @@ yo node-express-typescript-api
9191
│ ├── AuthRouter.ts
9292
│ ├── UserRouter.ts
9393
│ └── index.ts
94-
├── swagger.json
9594
├── swaggerDef.js
9695
├── tsconfig.json
97-
└── tslint.json
96+
└── .eslintrc.json
9897
```
9998
## Running the API
10099
### Development
@@ -128,7 +127,7 @@ Express server listening on http://localhost:3000/, in development mode
128127
The developer mode will watch your changes then will transpile the TypeScript code and re-run the node application automatically.
129128

130129
### Testing
131-
To run integration tests:
130+
To run integration tests:
132131
```bash
133132
npm test
134133
```
@@ -140,12 +139,7 @@ If you want to add some new variables, you also need to add them to interface an
140139
## Usage as OAuth2.0 Server
141140
To use this generator as OAuth2.0 server you should implement client side, that will be handle your redirectUris and make requests to `/auth/token/` route. [Read more about OAuth2.0](https://alexbilbie.com/guide-to-oauth-2-grants/)
142141

143-
## Swagger
144-
```bash
145-
npm install -g swagger-jsdoc
146-
swagger-jsdoc -d swaggerDef.js -o swagger.json
147-
```
148-
Swagger documentation will be available on route:
142+
Swagger documentation will be available on route:
149143
```bash
150144
http://localhost:3000/docs
151145
```

0 commit comments

Comments
 (0)