search

nestjs / nest

A progressive Node.js framework for building efficient, scalable, and enterprise-grade server-side applications with TypeScript/JavaScript 🚀
https://nestjs.com
MIT License
66.9k stars 7.55k forks source link

documentation is so terrible #4340

Closed quanzhiyuan closed 4 years ago

quanzhiyuan commented 4 years ago

nest.js is so cool. it use Typescript and use DI and AOP，but the learn documentation is so
hard to understand。 i don't know how to start a sample project， i don't know why i need Pipes, Middleware, guards, interceptors and what the execute order. the documentation's table of Contents is always confusion me. is the table of Contents has been carefully designed ?

quanzhiyuan commented 4 years ago

should it be friendly to front-end developers ?

johnbiundo commented 4 years ago

You should go through the documentation in the order it's presented. Start with the Overview section - First Steps, then Controllers, etc. It should answer your questions about Pipes, Middleware, Guards, etc. Also, look at the samples in the repository here: https://github.com/nestjs/nest/tree/master/sample. 01 and 15 are good starter examples. Once you've read those sections, ask your questions of the community here: https://discordapp.com/invite/G7Qnnhy. There are good resources the community can guide you to, or answer for you.