Skip to content

Commit a31beab

Browse files
author
hirsch88
committed
Update readme documentation
1 parent d16c2c0 commit a31beab

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ Try it!! We are happy to hear your feedback or any kind of new features.
3535
- **Easy Exception Handling** with our own simple and easy to adopt logic. You will love it.
3636
- **Easy Data Seeding** with our own factories.
3737
- **Custom Commands** are also available in our setup and really easy to use or even extend.
38+
- **Custom Validators** to validate your request even better and stricter. [custom-validation-classes](https://github.com/pleerock/class-validator#custom-validation-classes)
3839
- **Scaffolding Commands** will speed up your development tremendously as you should focus on business code and not scaffolding.
3940
- **Smart Validation** thanks to [class-validator](https://github.com/pleerock/class-validator) with some nice annotations.
4041
- **API Documentation** thanks to [swagger](http://swagger.io/).
@@ -152,7 +153,7 @@ All script are defined in the package.json file, but the most important ones are
152153
* There is also a vscode task for this called `lint`.
153154

154155
### Tests
155-
* Run the unit tests using `npm test` (There is also a vscode task for this called `test`).
156+
* Run the unit tests using `nps test` (There is also a vscode task for this called `test`).
156157
* Run the e2e tests using `nps test:e2e` and don't forget to start your application and your [Auth0 Mock Server](https://github.com/hirsch88/auth0-mock-server).
157158

158159
### Running in dev mode
@@ -230,6 +231,7 @@ The route prefix is `/api` by default, but you can change this in the .env file.
230231
| **src/api/repositories/** | Repository / DB layer |
231232
| **src/api/requests/** | Request bodys with validations |
232233
| **src/api/services/** | Service layer |
234+
| **src/api/validators/** | Custom validators, which can be used in the request classes |
233235
| **src/api/** swagger.json | Swagger documentation |
234236
| **src/console/** | Command line scripts |
235237
| **src/config/** | Configurations like database or logger |

0 commit comments

Comments
 (0)