Merge branch 'develop' into 'master'
Update readme.md See merge request !21
Showing
1 changed file
with
83 additions
and
10 deletions
| ... | @@ -10,20 +10,41 @@ KHU-Hub repo: [khuhub.khu.ac.kr/2018102216/dev-profile](https://khuhub.khu.ac.kr | ... | @@ -10,20 +10,41 @@ KHU-Hub repo: [khuhub.khu.ac.kr/2018102216/dev-profile](https://khuhub.khu.ac.kr |
| 10 | - [x] your basic profile | 10 | - [x] your basic profile |
| 11 | - [x] random quotes **_for developers_** to motivate you :sparkles: | 11 | - [x] random quotes **_for developers_** to motivate you :sparkles: |
| 12 | - [x] the amount of commits you've done on [GitHub](https://github.com/) at a glance | 12 | - [x] the amount of commits you've done on [GitHub](https://github.com/) at a glance |
| 13 | -- [ ] your most-contributed project on GitHub | 13 | +- [x] your most-contributed project on GitHub |
| 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 | + | ||
| 24 | + | ||
| 22 | ## <br> | 25 | ## <br> |
| 26 | +<br> | ||
| 27 | + | ||
| 28 | +## **Website URL** | ||
| 29 | +https://dev-profile-2021.herokuapp.com/ | ||
| 30 | + | ||
| 31 | +### ● Home Page | ||
| 32 | + 1. you can join or login with github. | ||
| 33 | + 2. you can search. | ||
| 34 | + | ||
| 23 | 35 | ||
| 24 | -### Developers | 36 | +### ● Myprofile Page |
| 37 | + 1. You can see your profile information, github contributions, repositories, status at a glance. | ||
| 38 | + | ||
| 39 | + | ||
| 40 | +### ● Editprofile Page | ||
| 41 | + 1. You can input or change your informations. | ||
| 42 | + | ||
| 43 | + | ||
| 44 | +## <br> | ||
| 45 | +<br> | ||
| 25 | 46 | ||
| 26 | -### test installation | 47 | +### ● Test installation |
| 27 | 48 | ||
| 28 | This is the usage just for the being. | 49 | This is the usage just for the being. |
| 29 | 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. |
| ... | @@ -41,10 +62,59 @@ npm run dev:server | ... | @@ -41,10 +62,59 @@ npm run dev:server |
| 41 | ```bash | 62 | ```bash |
| 42 | npm run dev:assets | 63 | npm run dev:assets |
| 43 | ``` | 64 | ``` |
| 65 | +## <br> | ||
| 66 | +<br> | ||
| 67 | + | ||
| 68 | +### ● Installation MongoDB | ||
| 69 | + 1. Access to the MongoDB homepage. | ||
| 70 | + | ||
| 71 | + | ||
| 72 | + 2. Select options and download MongoDB. | ||
| 73 | + | ||
| 44 | 74 | ||
| 75 | + 3. If this screen appears when installing MongoDB, please select 'complete' and proceed. | ||
| 76 | + | ||
| 77 | + | ||
| 78 | + 4. When you enter 'mongo' command in vsc terminal, it is installed well when the screen appears as below. | ||
| 79 | + | ||
| 80 | + | ||
| 81 | +### ● To setting environment variable. | ||
| 82 | +```bash | ||
| 83 | + -ps. When entering 'mongo' command in vsc terminal, skip this part if it runs well. | ||
| 84 | +``` | ||
| 85 | + 1. Find folder where mongoDB is installed, and make a copy of the folder's route. | ||
| 86 | + | ||
| 87 | + | ||
| 88 | + 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'. | ||
| 89 | + | ||
| 90 | + | ||
| 91 | + 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'. | ||
| 92 | + | ||
| 93 | + | ||
| 94 | + 4. Create a new environmental variable path using the Mongo db address you copied earlier. | ||
| 95 | + | ||
| 96 | + | ||
| 97 | + 5. Please check if Mongo Db is working well in fourth method of "Installation MongoDB". | ||
| 98 | + | ||
| 99 | +### ● Installation Nodejs | ||
| 100 | + install node js. | ||
| 101 | +## <br> | ||
| 45 | <br> | 102 | <br> |
| 46 | 103 | ||
| 47 | -### API reference | 104 | +### ● How to contribution our project. |
| 105 | + 1. Please fork our repository. | ||
| 106 | + 2. Change your branch to 'develop'. | ||
| 107 | + 3. Send pull request. | ||
| 108 | +## <br> | ||
| 109 | +<br> | ||
| 110 | + | ||
| 111 | +### ● How to fill .env file. | ||
| 112 | + 1. If you clone our repository and downloads required modules, make new '.env' file. | ||
| 113 | + 2. Fill in the required values as shown below. | ||
| 114 | + | ||
| 115 | +## <br> | ||
| 116 | + | ||
| 117 | +### ● API reference | ||
| 48 | 118 | ||
| 49 | [Programming Quotes API](quotes.stormconsultancy.co.uk/random.json) | 119 | [Programming Quotes API](quotes.stormconsultancy.co.uk/random.json) |
| 50 | 120 | ||
| ... | @@ -52,11 +122,14 @@ npm run dev:assets | ... | @@ -52,11 +122,14 @@ npm run dev:assets |
| 52 | 122 | ||
| 53 | [GitHub Contributuions API](https://api.github.com/graphql/) | 123 | [GitHub Contributuions API](https://api.github.com/graphql/) |
| 54 | 124 | ||
| 55 | -<br> | 125 | +[Github Recent Repositories API](https://api.github.com/users/${githubNickname}/repos?sort=updated&per_page=2) |
| 56 | -\\<!--[GitHub Repositories API] | ||
| 57 | 126 | ||
| 58 | -### Libraries | 127 | +<br> |
| 59 | 128 | ||
| 60 | -### 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 | ||
| 61 | 133 | ||
| 62 | -[MIT](https://choosealicense.com/licenses/mit/) | 134 | +### ● License |
| 135 | + [MIT](https://choosealicense.com/licenses/mit/) | ... | ... |
-
Please register or login to post a comment