WEBVTT

1
00:00.650 --> 00:01.850
Hi everyone.

2
00:01.880 --> 00:09.680
In this video let me show you how we can documentation for all of application.

3
00:09.710 --> 00:20.360
Okay, for whole application now in the recipe, click on compodoc right here and it's compodoc.

4
00:20.360 --> 00:22.520
Right here is a document tool okay.

5
00:22.550 --> 00:25.220
Actually this is for angular application.

6
00:25.820 --> 00:30.050
But we can use that in the NestJS right now.

7
00:30.200 --> 00:35.420
And we will we must install that using the dependency okay.

8
00:35.840 --> 00:37.580
You can do that.

9
00:40.760 --> 00:44.480
Let me install package okay.

10
00:45.230 --> 00:46.550
And let wait a bit.

11
00:46.550 --> 00:49.070
So it's still been installed.

12
00:50.900 --> 00:53.360
And after that we can try to use that.

13
00:53.630 --> 00:55.100
We can try to use here.

14
01:09.610 --> 01:09.910
Okay.

15
01:09.910 --> 01:16.510
After that. We will use this syntax to generate the documentation.

16
01:16.840 --> 01:19.990
Let me show you if I copy & paste

17
01:21.070 --> 01:30.880
And right now you also don't need to worry about what actually is the important to see, what is

18
01:30.880 --> 01:33.160
inside the documentation right here.

19
01:33.640 --> 01:33.940
Okay.

20
01:33.970 --> 01:37.600
After that it will generate for me something like that.

21
01:38.470 --> 01:39.040
Okay.

22
01:41.830 --> 01:42.970
It will processed.

23
01:43.000 --> 01:43.420
Right.

24
01:43.420 --> 01:49.810
And it will generate for me something on the documentation okay.

25
01:49.840 --> 01:52.180
You don't need to worry about error here.

26
01:52.990 --> 01:57.010
So it will have something called documents right.

27
01:57.790 --> 02:00.670
So let me try to open that.

28
02:00.700 --> 02:05.290
You see the localhost.

29
02:07.680 --> 02:08.340
80

30
02:08.370 --> 02:08.850
80

31
02:09.000 --> 02:10.260
Here we use.

32
02:12.270 --> 02:16.680
And if you say we have some stuff like that.

33
02:16.680 --> 02:20.640
And actually this is not what we want.

34
02:28.200 --> 02:28.260
To.

35
02:32.880 --> 02:35.970
I think because. The reason.

36
02:36.000 --> 02:42.120
Because I already have something called a apache tomcat in my localhost.

37
02:42.210 --> 02:44.940
So it will conflict right here.

38
02:51.330 --> 02:55.560
Let me show you how we can change the port

39
02:55.590 --> 02:58.680
Or you can open the document and open the index.

40
02:58.920 --> 03:03.630
And we can open the index file right here.

41
03:07.740 --> 03:16.050
Now you can see. if you run the index.html, you can see we have something like this, right?

42
03:16.530 --> 03:17.850
Very cool.

43
03:17.880 --> 03:26.070
Right now you can ses. This is my readme file right here.

44
03:30.450 --> 03:31.800
Right here we have readme.

45
03:31.830 --> 03:32.160
Okay.

46
03:32.160 --> 03:34.200
We can change that if you want.

47
03:37.200 --> 03:41.730
Now we have a some modules and inside the module we have an app module.

48
03:42.240 --> 03:42.510
Okay.

49
03:42.540 --> 03:46.620
This is my current application right.

50
03:52.680 --> 03:56.070
This is my module of application you can see.

51
03:56.160 --> 03:59.370
And we have an app module for example like that.

52
03:59.730 --> 04:07.710
Now you can see something right here. It has something like that, for example methods and something like this.

53
04:07.740 --> 04:09.600
You can try to read it.

54
04:10.470 --> 04:12.060
You can play around with us.

55
04:12.060 --> 04:14.840
And we also see the the code.

56
04:17.270 --> 04:18.920
And we have something call injectable

57
04:19.220 --> 04:22.250
You can see right here and also the code.

58
04:24.320 --> 04:26.150
And all over.

59
04:26.180 --> 04:26.750
Right.

60
04:27.410 --> 04:33.770
And we have some controller and we have a much so many classes and we have injectable.

61
04:38.000 --> 04:40.130
Let's playground with that if you want.

62
04:40.160 --> 04:40.580
Okay.

63
04:43.610 --> 04:46.160
Now it's already some file

64
04:46.190 --> 04:46.850
Very cool.

65
04:46.850 --> 04:47.480
Right.

66
04:48.500 --> 04:51.890
And right here you can zoom in.

67
04:51.920 --> 04:53.060
The application

68
04:53.270 --> 04:57.560
Like this. You can see the overview of the module application.

69
04:57.560 --> 04:58.010
Right.

70
04:58.970 --> 05:01.370
You can zoom out and reset in.

71
05:01.670 --> 05:04.610
And so right here we have so many information.

72
05:04.640 --> 05:07.430
You can try to click about them to see.

73
05:09.500 --> 05:10.010
Okay.

74
05:10.040 --> 05:13.310
Actually I very love this.

75
05:14.810 --> 05:15.260
Okay.

76
05:15.280 --> 05:25.480
So and actually if you use the GitHub you usually don't want to share the documentation.

77
05:25.900 --> 05:32.470
So for that reason we can open the git ignore right here

78
05:32.560 --> 05:34.060
And you can ignore that

79
05:39.160 --> 05:39.670
Okay.

80
05:40.570 --> 05:43.960
Or anyway. if you want to show

81
05:46.270 --> 05:58.300
Uh, if you want to show the documentation, you can open the folder and deploy this into

82
05:58.300 --> 06:02.320
the something like GitHub page.

83
06:02.350 --> 06:02.650
Okay.

84
06:02.680 --> 06:12.610
Because this's just a static page. Right? Feel free to do that. That's it. That's for the video

85
06:12.640 --> 06:18.970
So I just want to give you some idea and I will see you in the next one.