이세진 / dev-profile

Go to a project
Toggle navigation Toggle navigation pinning
JungSeungHyun
65200f49 2 parents 18946d6c e41499e9

Update README.md for modify overall

Inline Side-by-side
Showing 1 changed file with 40 additions and 18 deletions
...@@ -14,27 +14,37 @@ KHU-Hub repo: [khuhub.khu.ac.kr/2018102216/dev-profile](https://khuhub.khu.ac.kr ...@@ -14,27 +14,37 @@ KHU-Hub repo: [khuhub.khu.ac.kr/2018102216/dev-profile](https://khuhub.khu.ac.kr
14 - [x] today's trending repositories on GitHub 14 - [x] today's trending repositories on GitHub
15 <br> 15 <br>
16 16
17 -### Additional Features 17 +### ● Additional Features
18 18
19 - [x] direct and easy login via GitHub 19 - [x] direct and easy login via GitHub
20 - [x] intuitive and easy-to-use structure 20 - [x] intuitive and easy-to-use structure
21 21
22 +### ● Road Map
23 +![image](/uploads/c79b5a9c5f133336c0361898721341a8/image.png)
24 +
22 ## <br> 25 ## <br>
26 +<br>
27 +
28 +## **Website URL**
29 +https://dev-profile-2021.herokuapp.com/
23 30
24 -### Home Page 31 +### ● Home Page
25 1. you can join or login with github. 32 1. you can join or login with github.
26 2. you can search. 33 2. you can search.
27 ![image](/uploads/f33744dd78985b881bfeff6162af0919/image.png) 34 ![image](/uploads/f33744dd78985b881bfeff6162af0919/image.png)
28 35
29 -### Myprofile Page 36 +### ● Myprofile Page
30 1. You can see your profile information, github contributions, repositories, status at a glance. 37 1. You can see your profile information, github contributions, repositories, status at a glance.
31 ![image](/uploads/63eae503a0eb49b22bbe545c3c0c859a/image.png) 38 ![image](/uploads/63eae503a0eb49b22bbe545c3c0c859a/image.png)
32 39
33 -### Editprofile Page 40 +### ● Editprofile Page
34 1. You can input or change your informations. 41 1. You can input or change your informations.
35 ![image](/uploads/55988a03a91f0dcd33656afe0ec04ff6/image.png) 42 ![image](/uploads/55988a03a91f0dcd33656afe0ec04ff6/image.png)
36 43
37 -### test installation 44 +## <br>
45 +<br>
46 +
47 +### ● Test installation
38 48
39 This is the usage just for the being. 49 This is the usage just for the being.
40 After cloning repository, type into terminal to automatically install modules and libraries. 50 After cloning repository, type into terminal to automatically install modules and libraries.
...@@ -52,10 +62,10 @@ npm run dev:server ...@@ -52,10 +62,10 @@ npm run dev:server
52 ```bash 62 ```bash
53 npm run dev:assets 63 npm run dev:assets
54 ``` 64 ```
55 - 65 +## <br>
56 <br> 66 <br>
57 67
58 -### Installation MongoDB 68 +### ● Installation MongoDB
59 1. Access to the MongoDB homepage. 69 1. Access to the MongoDB homepage.
60 ![homepage](https://oss-2020105657.s3.amazonaws.com/MongoDB+homepage.png) 70 ![homepage](https://oss-2020105657.s3.amazonaws.com/MongoDB+homepage.png)
61 71
...@@ -68,9 +78,10 @@ npm run dev:assets ...@@ -68,9 +78,10 @@ npm run dev:assets
68 4. When you enter 'mongo' command in vsc terminal, it is installed well when the screen appears as below. 78 4. When you enter 'mongo' command in vsc terminal, it is installed well when the screen appears as below.
69 ![image](/uploads/202bf8555f6842938d15c6e3b0e789c1/image.png) 79 ![image](/uploads/202bf8555f6842938d15c6e3b0e789c1/image.png)
70 80
71 -### To setting environment variable. 81 +### ● To setting environment variable.
72 - ps. When entering 'mongo' command in vsc terminal, skip this part if it runs well. 82 +```bash
73 - 83 + -ps. When entering 'mongo' command in vsc terminal, skip this part if it runs well.
84 +```
74 1. Find folder where mongoDB is installed, and make a copy of the folder's route. 85 1. Find folder where mongoDB is installed, and make a copy of the folder's route.
75 ![image](/uploads/93b13c8df931ef11781d21ad574ee441/image.png) 86 ![image](/uploads/93b13c8df931ef11781d21ad574ee441/image.png)
76 87
...@@ -85,17 +96,25 @@ npm run dev:assets ...@@ -85,17 +96,25 @@ npm run dev:assets
85 96
86 5. Please check if Mongo Db is working well in fourth method of "Installation MongoDB". 97 5. Please check if Mongo Db is working well in fourth method of "Installation MongoDB".
87 98
88 -### How to contribution our project. 99 +### ● Installation Nodejs
100 + install node js.
101 +## <br>
102 +<br>
103 +
104 +### ● How to contribution our project.
89 1. Please fork our repository. 105 1. Please fork our repository.
90 2. Change your branch to 'developer'. 106 2. Change your branch to 'developer'.
91 3. Send pull request. 107 3. Send pull request.
108 +## <br>
109 +<br>
92 110
93 -### How to fill .env file. 111 +### ● How to fill .env file.
94 1. If you clone our repository and downloads required modules, make new '.env' file. 112 1. If you clone our repository and downloads required modules, make new '.env' file.
95 2. Fill in the required values as shown below. 113 2. Fill in the required values as shown below.
96 ![image](/uploads/cbdf2726a8b5c6326378cd5fa8295726/image.png) 114 ![image](/uploads/cbdf2726a8b5c6326378cd5fa8295726/image.png)
115 +## <br>
97 116
98 -### API reference 117 +### ● API reference
99 118
100 [Programming Quotes API](quotes.stormconsultancy.co.uk/random.json) 119 [Programming Quotes API](quotes.stormconsultancy.co.uk/random.json)
101 120
...@@ -103,11 +122,14 @@ npm run dev:assets ...@@ -103,11 +122,14 @@ npm run dev:assets
103 122
104 [GitHub Contributuions API](https://api.github.com/graphql/) 123 [GitHub Contributuions API](https://api.github.com/graphql/)
105 124
106 -<br> 125 +[Github Recent Repositories API](https://api.github.com/users/${githubNickname}/repos?sort=updated&per_page=2)
107 -\\<!--[GitHub Repositories API]
108 126
109 -### Libraries 127 +<br>
110 128
111 -### License 129 +### ● Contact way to Contributor
130 + Lee Se Jin : lsj8706@naver.com
131 + Kim Cherrie : cherriekim925@gmail.com
132 + Jung Seoung Hyun : jshbest00@khu.ac.kr
112 133
113 -[MIT](https://choosealicense.com/licenses/mit/) 134 +### ● License
135 + [MIT](https://choosealicense.com/licenses/mit/)
......