JungSeungHyun

Update README.md Project Architecture

Showing 1 changed file with 76 additions and 24 deletions
...@@ -20,30 +20,37 @@ KHU-Hub repo : [khuhub.khu.ac.kr/2018102216/dev-profile](https://khuhub.khu.ac.k ...@@ -20,30 +20,37 @@ KHU-Hub repo : [khuhub.khu.ac.kr/2018102216/dev-profile](https://khuhub.khu.ac.k
20 - [x] direct and easy login via GitHub 20 - [x] direct and easy login via GitHub
21 - [x] intuitive and easy-to-use structure 21 - [x] intuitive and easy-to-use structure
22 22
23 -### ● Road Map
24 -![roadmap](https://oss-2020105657.s3.amazonaws.com/roadmap.png)
25 -## <br>
26 <br> 23 <br>
27 24
28 ### ● Home Page 25 ### ● Home Page
29 - 1. you can join or login with github. 26 +
30 - 2. you can search. 27 + 1. You can join or login with GitHub account.
28 + 2. You can search via Google.
29 +
31 ![homepage](https://oss-2020105657.s3.amazonaws.com/homepage.png) 30 ![homepage](https://oss-2020105657.s3.amazonaws.com/homepage.png)
32 31
33 ### ● Myprofile Page 32 ### ● Myprofile Page
33 +
34 1. You can see your profile information, github contributions, repositories, status at a glance. 34 1. You can see your profile information, github contributions, repositories, status at a glance.
35 +
35 ![image](https://oss-2020105657.s3.amazonaws.com/myprofile.png) 36 ![image](https://oss-2020105657.s3.amazonaws.com/myprofile.png)
36 37
37 -### ● Editprofile Page 38 +### ● Edit Profile Page
39 +
38 1. You can input or change your informations. 40 1. You can input or change your informations.
41 +
39 ![image](https://oss-2020105657.s3.amazonaws.com/edit+profile.png) 42 ![image](https://oss-2020105657.s3.amazonaws.com/edit+profile.png)
40 43
41 ## <br> 44 ## <br>
45 +
42 <br> 46 <br>
43 47
44 ### ● Test installation 48 ### ● Test installation
45 49
46 -This is the usage just for the being. 50 +<details>
51 +<summary>Click to see full walkthrough!</summary>
52 +<div markdown="1">
53 +
47 After cloning repository, type into terminal to automatically install modules and libraries. 54 After cloning repository, type into terminal to automatically install modules and libraries.
48 55
49 ```bash 56 ```bash
...@@ -59,58 +66,107 @@ npm run dev:server ...@@ -59,58 +66,107 @@ npm run dev:server
59 ```bash 66 ```bash
60 npm run dev:assets 67 npm run dev:assets
61 ``` 68 ```
69 +
62 ## <br> 70 ## <br>
71 +
63 <br> 72 <br>
64 73
65 -### ● Installation MongoDB 74 +### ● MongoDB Installation
75 +
66 1. Access to the MongoDB homepage. 76 1. Access to the MongoDB homepage.
77 +
67 ![homepage](https://oss-2020105657.s3.amazonaws.com/MongoDB+homepage.png) 78 ![homepage](https://oss-2020105657.s3.amazonaws.com/MongoDB+homepage.png)
68 79
69 2. Select options and download MongoDB. 80 2. Select options and download MongoDB.
81 +
70 ![options](https://oss-2020105657.s3.amazonaws.com/MongoDB+install.png) 82 ![options](https://oss-2020105657.s3.amazonaws.com/MongoDB+install.png)
71 83
72 3. If this screen appears when installing MongoDB, please select 'complete' and proceed. 84 3. If this screen appears when installing MongoDB, please select 'complete' and proceed.
85 +
73 ![precaution](https://oss-2020105657.s3.amazonaws.com/MongoDB+precaution.png) 86 ![precaution](https://oss-2020105657.s3.amazonaws.com/MongoDB+precaution.png)
74 87
75 - 4. When you enter 'mongo' command in vsc terminal, it is installed well when the screen appears as below. 88 + 4. If you enter 'mongo' command in vsc terminal, it will be installed with the screen appearing as below.
89 +
76 ![image](https://oss-2020105657.s3.amazonaws.com/MongoDB+installation+well.png) 90 ![image](https://oss-2020105657.s3.amazonaws.com/MongoDB+installation+well.png)
77 91
78 -### ● To setting environment variable. 92 +### ● Setting environment variables
93 +
79 ```bash 94 ```bash
80 -ps. When entering 'mongo' command in vsc terminal, skip this part if it runs well. 95 -ps. When entering 'mongo' command in vsc terminal, skip this part if it runs well.
81 ``` 96 ```
82 - 1. Find folder where mongoDB is installed, and make a copy of the folder's route. 97 +
98 + 1. Find the folder where mongoDB is installed, and copy the folder's route.
99 +
83 ![image](https://oss-2020105657.s3.amazonaws.com/MongoDB+path.png) 100 ![image](https://oss-2020105657.s3.amazonaws.com/MongoDB+path.png)
84 101
85 - 2. And you open the 'environment variable' page. If using window environment, you can use command (window + R) and input 'sysdm.cpl ,3'. And click 'environment variable'. 102 + 2. Open the 'environment variable' page. In Windows environment, you can use command (window + R) and input 'sysdm.cpl ,3'. Then, click 'environment variable'.
103 +
86 ![image](https://oss-2020105657.s3.amazonaws.com/environment+window.png) 104 ![image](https://oss-2020105657.s3.amazonaws.com/environment+window.png)
87 105
88 3. You must find 'path' in 'system variable' categroy, not 'users variable'. If you find 'path' in 'system variable', then check 'path' and click 'Editing'. 106 3. You must find 'path' in 'system variable' categroy, not 'users variable'. If you find 'path' in 'system variable', then check 'path' and click 'Editing'.
107 +
89 ![image](https://oss-2020105657.s3.amazonaws.com/Find+path+in+system+variable.png) 108 ![image](https://oss-2020105657.s3.amazonaws.com/Find+path+in+system+variable.png)
90 109
91 4. Create a new environmental variable path using the Mongo db address you copied earlier. 110 4. Create a new environmental variable path using the Mongo db address you copied earlier.
111 +
92 ![image](https://oss-2020105657.s3.amazonaws.com/make+new+environment+path.png) 112 ![image](https://oss-2020105657.s3.amazonaws.com/make+new+environment+path.png)
93 113
94 - 5. Please check if Mongo Db is working well in fourth method of "Installation MongoDB". 114 + 5. Please check if Mongo Db is working well refering to the fourth method of "MongoDB Installation".
115 +
116 +### ● Nodejs Installation
95 117
96 -### ● Installation Nodejs
97 install node js. 118 install node js.
119 +
120 +</div>
121 +</details>
122 +
98 ## <br> 123 ## <br>
124 +
99 <br> 125 <br>
100 126
101 -### ● How to contribution our project. 127 +### ● Project Architecture
102 - 1. Please fork our repository. 128 +
103 - 2. Change your branch to 'develop'. 129 +![image](https://cherriesbucket.s3.amazonaws.com/OSS_Project_Architecture.png)
104 - 3. Send pull request. 130 +
105 ## <br> 131 ## <br>
132 +
106 <br> 133 <br>
107 134
108 -### ● How to fill .env file. 135 +### ● Road Map
136 +
137 +![roadmap](https://oss-2020105657.s3.amazonaws.com/roadmap.png)
138 +
139 +## <br>
140 +
141 +### ● How to fill .env file
142 +
109 1. If you clone our repository and downloads required modules, make new '.env' file. 143 1. If you clone our repository and downloads required modules, make new '.env' file.
110 2. Fill in the required values as shown below. 144 2. Fill in the required values as shown below.
145 +
111 ![image](https://oss-2020105657.s3.amazonaws.com/fill+env+file.png) 146 ![image](https://oss-2020105657.s3.amazonaws.com/fill+env+file.png)
147 +
112 ## <br> 148 ## <br>
113 149
150 +<br>
151 +
152 +### ● How to contribute our project
153 +
154 + 1. Please fork our repository.
155 + 2. Change your branch to 'develop'.
156 + 3. Send pull request.
157 +
158 +## <br>
159 +
160 +<br>
161 +
162 +### ● Contributor Contact
163 +
164 + Lee Se Jin : lsj8706@naver.com
165 + Kim Cherrie : cherriekim925@gmail.com
166 + Jung Seoung Hyun : jshbest00@khu.ac.kr
167 +
168 +<br>
169 +
114 ### ● API reference 170 ### ● API reference
115 171
116 [Programming Quotes API](quotes.stormconsultancy.co.uk/random.json) 172 [Programming Quotes API](quotes.stormconsultancy.co.uk/random.json)
...@@ -123,10 +179,6 @@ npm run dev:assets ...@@ -123,10 +179,6 @@ npm run dev:assets
123 179
124 <br> 180 <br>
125 181
126 -### ● Contact way to Contributor
127 - Lee Se Jin : lsj8706@naver.com
128 - Kim Cherrie : cherriekim925@gmail.com
129 - Jung Seoung Hyun : jshbest00@khu.ac.kr
130 -
131 ### ● License 182 ### ● License
183 +
132 [MIT](https://choosealicense.com/licenses/mit/) 184 [MIT](https://choosealicense.com/licenses/mit/)
......