---
# System prepended metadata

title: '<center>2^nd^ August, 2019</center>'
tags: [Daily Internship Documentation]

---

# <center>2^nd^ August, 2019</center>

###### tags: `Daily Internship Documentation`
---
## 23^rd^ Day of Internship

## Summary

Today I have a weekly meeting with the Professor ant IoT team. I also generate a typedoc for the Student App. So, the other developers could easily read the documentation of the Student App.

URL:
* [**NTUST_SmartDispenser Github ver 2019.08.02**](https://github.com/ianjoseph2204/NTUST_SmartDispenser/tree/4b6632bad5719e151c21e315dc1805a3a130f24d)

---
## Weekly Presentation Powerpoint

{%slideshare IanJoseph13/20190802-ian-josephstatusreport %}

---
## Documentation

### 1. How to Generate a typedoc

1. <font color=brown>Install typedoc on your Node.js</font>
```shell=
$ npm install typedoc
```

* If you want the typedoc to be available in your project, you could install it with this command:
```shell=
$ npm install typedoc --save-dev
```

* If you want the typedoc to be available globally in your computer, you could install it with this command:
```shell=
$ npm install typedoc --global
```

2. <font color=brown>I suggest you create a doc folder in your project.</font>
![](https://i.imgur.com/v4Ml6ul.png)

3. <font color=brown>Change your directory to your current project. In the example below, I change the directory to my current project.</font>
```shell=
$ cd /d E:\Ionic\NTUST_SmartDispenser
```

4. <font color=brown>Run this command to generate a typedoc in your doc folder. In the example below, I use my current project path as the destination path of the typedoc.</font>
```shell=
$ typedoc --out E:\Ionic\NTUST_SmartDispenser\doc
```
5. <font color=brown>The typedoc will be generated like this:</font>
![](https://i.imgur.com/htYC5I5.png)

### 2. How to Access the Typedoc

1. <font color=brown> Copy the index.html path of the typedoc and open it in your browser.</font>
![](https://i.imgur.com/V0RSp6r.png)

2. <font color=brown>Click one directory that shown on the right side of the page.</font>
![](https://i.imgur.com/2we19fS.png)

3. <font color=brown>Click the DashboardPage</font>
![](https://i.imgur.com/hvTKcWQ.png)

4. <font color=brown>This is the page of the DashboardPage documentation</font>
![](https://i.imgur.com/OG5toQW.png)
![](https://i.imgur.com/ygXP0jR.png)
![](https://i.imgur.com/lEVHsMa.png)
![](https://i.imgur.com/wpAhxzU.png)

5. Click one component in the Index to go to the detail.
![](https://i.imgur.com/3yDactK.png)

<font color=brown>Click the link to go to the source code part</font>
![](https://i.imgur.com/1brrdzD.png)

<font color=brown>A source code page will be opened from Github.</font>
![](https://i.imgur.com/8TWH87S.png)

---
## Result

<font color=red>Here some overview of the typedoc:</font>
![](https://i.imgur.com/q2Kzbl3.gif)
