README

README.md

@@ -1,37 +1,79 @@
-## Welcome to GitHub Pages
+# README #
+## Source structure
 
-You can use the [editor on GitHub](https://github.com/smartbiz/HelpdeskBot/edit/master/README.md) to maintain and preview the content for your website in Markdown files.
+```
+├── app
+│   ├── handlers
+│   │   └── fileanissue.js
+│   └── models
+│       ├── columne.model.js
+│       ├── label.model.js
+│       ├── milestone.model.js
+│       └── project.model.js
+├── assets
+│   ├── json
+│   │   └── github_organization.json
+│   └── it-helpdesk-structure.xlsx
+├── config
+│   ├── .env
+│   ├── constants.js
+│   ├── index.js
+│   └── mongodb.js
+├── package.json
+├── README.md
+```
+## Setup
 
-Whenever you commit to this repository, GitHub Pages will run [Jekyll](https://jekyllrb.com/) to rebuild the pages in your site, from the content in your Markdown files.
+- Start MongoDB
+```
+$ sudo service mongod start
+```
+- Run node server to create github structure from json
+```
+$ node createGitHubStructure.js
+```
+- After structure already has created, stop node server
 
-### Markdown
+- Run node server
+```
+$ node index.js
+```
+## Service Desk Bot Flow
 
-Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for
+### 1. Create issue on Workplace
 
-```markdown
-Syntax highlighted code block
+- Pattern to create a issue on workplace
 
-# Header 1
-## Header 2
-### Header 3
+```
+@Bot_name Title_of_Issue#Assignee#Priority#Type_of_Issue
+```
+- Priority such as: High, Low, Medium
+- Type of issue such as: Access/Login, Desktop/Laptop/Hardware, Internet/Intranet ...
 
-- Bulleted
-- List
+Example: @ServiceDeskBot Can't Login Desktop#smartbiz#High#Access/Login
 
-1. Numbered
-2. List
+![](/assets/images/create-issue-workplace.png)
 
-**Bold** and _Italic_ and `Code` text
+- Workplace will post a message if create a issue is success
 
-[Link](url) and ![Image](src)
-```
+![](/assets/images/create-issue-success.png)
+
+
+### 2. Handle issue on github
+- Click on issue's link on workplace to see detail on github as below
+
+![](/assets/images/issue-github.png)
+
+- Issues are organized as dashboard below
 
-For more details see [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/).
+![](/assets/images/dashboard-github.png)
 
-### Jekyll Themes
+- After close a issue, this issue will auto move to Close column on dashboard
 
-Your Pages site will use the layout and styles from the Jekyll theme you have selected in your [repository settings](https://github.com/smartbiz/HelpdeskBot/settings). The name of this theme is saved in the Jekyll `_config.yml` configuration file.
+![](/assets/images/close-issue.png)
+![](/assets/images/dashboard-move.png)
 
-### Support or Contact
+### 3. Workplace notify the issue is close
+- Workplace will notify as below
 
-Having trouble with Pages? Check out our [documentation](https://help.github.com/categories/github-pages-basics/) or [contact support](https://github.com/contact) and we’ll help you sort it out.
+![](/assets/images/workplace-notify.png)