Hi everyone.
In this video let me show you how we can documentation for all of application.
Okay, for whole application now in the recipe, click on compodoc right here and it's compodoc.
Right here is a document tool okay.
Actually this is for angular application.
But we can use that in the NestJS right now.
And we will we must install that using the dependency okay.
You can do that.
Let me install package okay.
And let wait a bit.
So it's still been installed.
And after that we can try to use that.
We can try to use here.
Okay.
After that. We will use this syntax to generate the documentation.
Let me show you if I copy & paste
And right now you also don't need to worry about what actually is the important to see, what is
inside the documentation right here.
Okay.
After that it will generate for me something like that.
Okay.
It will processed.
Right.
And it will generate for me something on the documentation okay.
You don't need to worry about error here.
So it will have something called documents right.
So let me try to open that.
You see the localhost.
80
Here we use.
And if you say we have some stuff like that.
And actually this is not what we want.
To.
I think because. The reason.
Because I already have something called a apache tomcat in my localhost.
So it will conflict right here.
Let me show you how we can change the port
Or you can open the document and open the index.
And we can open the index file right here.
Now you can see. if you run the index.html, you can see we have something like this, right?
Very cool.
Right now you can ses. This is my readme file right here.
Right here we have readme.
Okay.
We can change that if you want.
Now we have a some modules and inside the module we have an app module.
Okay.
This is my current application right.
This is my module of application you can see.
And we have an app module for example like that.
Now you can see something right here. It has something like that, for example methods and something like this.
You can try to read it.
You can play around with us.
And we also see the the code.
And we have something call injectable
You can see right here and also the code.
And all over.
Right.
And we have some controller and we have a much so many classes and we have injectable.
Let's playground with that if you want.
Okay.
Now it's already some file
Very cool.
Right.
And right here you can zoom in.
The application
Like this. You can see the overview of the module application.
Right.
You can zoom out and reset in.
And so right here we have so many information.
You can try to click about them to see.
Okay.
Actually I very love this.
Okay.
So and actually if you use the GitHub you usually don't want to share the documentation.
So for that reason we can open the git ignore right here
And you can ignore that
Okay.
Or anyway. if you want to show
Uh, if you want to show the documentation, you can open the folder and deploy this into
the something like GitHub page.
Okay.
Because this's just a static page. Right? Feel free to do that. That's it. That's for the video
So I just want to give you some idea and I will see you in the next one.