# <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>

$ npm install typedoc

* If you want the typedoc to be available in your project, you could install it with this command:

$ npm install typedoc --save-dev

* If you want the typedoc to be available globally in your computer, you could install it with this command:

$ npm install typedoc --global

2. <font color=brown>I suggest you create a doc folder in your project.</font>

3. <font color=brown>Change your directory to your current project. In the example below, I change the directory to my current project.</font>

$ 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>

$ typedoc --out E:\Ionic\NTUST_SmartDispenser\doc

5. <font color=brown>The typedoc will be generated like this:</font>

### 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>

2. <font color=brown>Click one directory that shown on the right side of the page.</font>

3. <font color=brown>Click the DashboardPage</font>

4. <font color=brown>This is the page of the DashboardPage documentation</font>

5. Click one component in the Index to go to the detail.

<font color=brown>Click the link to go to the source code part</font>

<font color=brown>A source code page will be opened from Github.</font>

---
## Result

<font color=red>Here some overview of the typedoc:</font>