Updated README.md - added Project Architecture along with a few more minor changes.

김채리
Commit 8aeeb7164492f778fb607e1bc836c8e02c08f80e 8aeeb716 1 parent 37f88289
Showing 1 changed file with 117 additions and 34 deletions
README.md
--- a/README.md
View file @8aeeb71
+++ b/README.md
View file @8aeeb71
 # DEV-profile
-### **A website for developers to get driven with motivation.**
+## **A website for developers to get driven with motivation.**
-KHU-Hub repo: [khuhub.khu.ac.kr/2018102216/dev-profile](https://khuhub.khu.ac.kr/2018102216/dev-profile)
+dev-profile URL : https://dev-profile-2021.herokuapp.com/
+
+KHU-Hub repo : [khuhub.khu.ac.kr/2018102216/dev-profile](https://khuhub.khu.ac.kr/2018102216/dev-profile)
 <br>
 ## Main Features
@@ -12,20 +14,43 @@ KHU-Hub repo: [khuhub.khu.ac.kr/2018102216/dev-profile](https://khuhub.khu.ac.kr
 - [x] the amount of commits you've done on [GitHub](https://github.com/) at a glance
 - [x] your most-contributed project on GitHub
 - [x] today's trending repositories on GitHub
-      <br>
-### Additional Features
+### ● Additional Features
 - [x] direct and easy login via GitHub
 - [x] intuitive and easy-to-use structure
+<br>
+
+### ● Home Page
+
+    1. You can join or login with GitHub account.
+    2. You can search via Google.
+
+![homepage](https://oss-2020105657.s3.amazonaws.com/homepage.png)
+
+### ● Myprofile Page
+
+    1. You can see your profile information, github contributions, repositories, status at a glance.
+
+![image](https://oss-2020105657.s3.amazonaws.com/myprofile.png)
+
+### ● Edit Profile Page
+
+    1. You can input or change your informations.
+
+![image](https://oss-2020105657.s3.amazonaws.com/edit+profile.png)
+
 ## <br>
-### Developers
+<br>
+
+### ● Test installation
-### test installation
+<details>
+<summary>Click to see full walkthrough!</summary>
+<div markdown="1">
-This is the usage just for the being.
 After cloning repository, type into terminal to automatically install modules and libraries.
 ```bash
@@ -42,48 +67,107 @@ npm run dev:server
 npm run dev:assets
 ```
+## <br>
+
 <br>
-### Installation MongoDB
+
+### ● MongoDB Installation
+
     1. Access to the MongoDB homepage.
-    ![image](/uploads/3d5d283732343d4c5ff4b5c7bd16c78f/image.png)
+
+![homepage](https://oss-2020105657.s3.amazonaws.com/MongoDB+homepage.png)
     2. Select options and download MongoDB.
-    ![image](/uploads/46038b5c881bb18074dd8e732804f5d7/image.png)
+
+![options](https://oss-2020105657.s3.amazonaws.com/MongoDB+install.png)
     3. If this screen appears when installing MongoDB, please select 'complete' and proceed.
-    ![image](/uploads/510d184825d6eaf04dcb2d254f03b918/image.png)
-    4. When you enter 'mongo' command in vsc terminal, it is installed well when the screen appears as below.
+![precaution](https://oss-2020105657.s3.amazonaws.com/MongoDB+precaution.png)
-    ![image](/uploads/202bf8555f6842938d15c6e3b0e789c1/image.png)
+
+    4. If you enter 'mongo' command in vsc terminal, it will be installed with the screen appearing as below.
+
+![image](https://oss-2020105657.s3.amazonaws.com/MongoDB+installation+well.png)
+
+### ● Setting environment variables
+
+```bash
+    -ps. When entering 'mongo' command in vsc terminal, skip this part if it runs well.
+```
-### To setting environment variable.
+    1. Find the folder where mongoDB is installed, and copy the folder's route.
-    ps. When entering 'mongo' command in vsc terminal, skip this part if it runs well.
-    1. Find folder where mongoDB is installed, and make a copy of the folder's route.
+![image](https://oss-2020105657.s3.amazonaws.com/MongoDB+path.png)
-    ![image](/uploads/93b13c8df931ef11781d21ad574ee441/image.png)
-    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'.
+    2. Open the 'environment variable' page. In Windows environment, you can use command (window + R) and input 'sysdm.cpl ,3'. Then, click 'environment variable'.
-    ![image](/uploads/64278904603d6b3cdb78a0689695344a/image.png)
+
+![image](https://oss-2020105657.s3.amazonaws.com/environment+window.png)
     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'.
-    ![image](/uploads/9077ec8854585640dfb526e45cbcb3fb/image.png)
+
+![image](https://oss-2020105657.s3.amazonaws.com/Find+path+in+system+variable.png)
     4. Create a new environmental variable path using the Mongo db address you copied earlier.
-    ![image](/uploads/0018e1de51ae1c10cc9a5d5bc01fcf9d/image.png)
-    5. Please check if Mongo Db is working well in fourth method of "Installation MongoDB".
+![image](https://oss-2020105657.s3.amazonaws.com/make+new+environment+path.png)
-### How to contribution our project.
+    5. Please check if Mongo Db is working well refering to the fourth method of "MongoDB Installation".
-    1. Please fork our repository.
+
-    2. Change your branch to 'developer'.
+### ● Nodejs Installation
-    3. Send pull request.
+
+    install node js.
+
+</div>    
+</details>
+
+## <br>
+
+<br>
+
+### ● Project Architecture
+
+![image](https://cherriesbucket.s3.amazonaws.com/OSS_Project_Architecture.png)
+
+## <br>
+
+<br>
+
+### ● Road Map
+
+![roadmap](https://oss-2020105657.s3.amazonaws.com/roadmap.png)
+
+## <br>
+
+### ● How to fill .env file
-### How to fill .env file.
     1. If you clone our repository and downloads required modules, make new '.env' file.
     2. Fill in the required values as shown below.
-    ![image](/uploads/cbdf2726a8b5c6326378cd5fa8295726/image.png)
-### API reference
+![image](https://oss-2020105657.s3.amazonaws.com/fill+env+file.png)
+
+## <br>
+
+<br>
+
+### ● How to contribute our project
+
+    1. Please fork our repository.
+    2. Change your branch to 'develop'.
+    3. Send pull request.
+
+## <br>
+
+<br>
+
+### ● Contributor Contact
+
+    Lee Se Jin : lsj8706@naver.com
+    Kim Cherrie : cherriekim925@gmail.com
+    Jung Seoung Hyun : jshbest00@khu.ac.kr
+
+<br>
+
+### ● API reference
 [Programming Quotes API](quotes.stormconsultancy.co.uk/random.json)
@@ -91,11 +175,10 @@ npm run dev:assets
 [GitHub Contributuions API](https://api.github.com/graphql/)
-<br>
+[Github Recent Repositories API](https://api.github.com/users/${githubNickname}/repos?sort=updated&per_page=2)
-\\<!--[GitHub Repositories API]
-### Libraries
+<br>
-### License
+### ● License
-[MIT](https://choosealicense.com/licenses/mit/)
+    [MIT](https://choosealicense.com/licenses/mit/)