JungSeungHyun

Update README.md for modify overall

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
- [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
### ● Road Map
![image](/uploads/c79b5a9c5f133336c0361898721341a8/image.png)
## <br>
<br>
## **Website URL**
https://dev-profile-2021.herokuapp.com/
### Home Page
### Home Page
1. you can join or login with github.
2. you can search.
![image](/uploads/f33744dd78985b881bfeff6162af0919/image.png)
### Myprofile Page
### Myprofile Page
1. You can see your profile information, github contributions, repositories, status at a glance.
![image](/uploads/63eae503a0eb49b22bbe545c3c0c859a/image.png)
### Editprofile Page
### Editprofile Page
1. You can input or change your informations.
![image](/uploads/55988a03a91f0dcd33656afe0ec04ff6/image.png)
### test installation
## <br>
<br>
### ● Test installation
This is the usage just for the being.
After cloning repository, type into terminal to automatically install modules and libraries.
......@@ -52,10 +62,10 @@ npm run dev:server
```bash
npm run dev:assets
```
## <br>
<br>
### Installation MongoDB
### Installation MongoDB
1. Access to the MongoDB homepage.
![homepage](https://oss-2020105657.s3.amazonaws.com/MongoDB+homepage.png)
......@@ -68,9 +78,10 @@ npm run dev:assets
4. When you enter 'mongo' command in vsc terminal, it is installed well when the screen appears as below.
![image](/uploads/202bf8555f6842938d15c6e3b0e789c1/image.png)
### To setting environment variable.
ps. When entering 'mongo' command in vsc terminal, skip this part if it runs well.
### ● To setting environment variable.
```bash
-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](/uploads/93b13c8df931ef11781d21ad574ee441/image.png)
......@@ -85,17 +96,25 @@ npm run dev:assets
5. Please check if Mongo Db is working well in fourth method of "Installation MongoDB".
### How to contribution our project.
### ● Installation Nodejs
install node js.
## <br>
<br>
### ● How to contribution our project.
1. Please fork our repository.
2. Change your branch to 'developer'.
3. Send pull request.
## <br>
<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)
## <br>
### API reference
### API reference
[Programming Quotes API](quotes.stormconsultancy.co.uk/random.json)
......@@ -103,11 +122,14 @@ npm run dev:assets
[GitHub Contributuions API](https://api.github.com/graphql/)
<br>
\\<!--[GitHub Repositories API]
[Github Recent Repositories API](https://api.github.com/users/${githubNickname}/repos?sort=updated&per_page=2)
### Libraries
<br>
### License
### ● Contact way to Contributor
Lee Se Jin : lsj8706@naver.com
Kim Cherrie : cherriekim925@gmail.com
Jung Seoung Hyun : jshbest00@khu.ac.kr
[MIT](https://choosealicense.com/licenses/mit/)
### ● License
[MIT](https://choosealicense.com/licenses/mit/)
......