README.md
3.61 KB
DEV-profile
A website for developers to get driven with motivation.
KHU-Hub repo: khuhub.khu.ac.kr/2018102216/dev-profile
Main Features
- your basic profile
-
random quotes for developers to motivate you
- the amount of commits you've done on GitHub at a glance
- your most-contributed project on GitHub
-
today's trending repositories on GitHub
Additional Features
- direct and easy login via GitHub
- intuitive and easy-to-use structure
Home Page
1. you can join or login with github.
2. you can search.
Myprofile Page
1. You can see your profile information, github contributions, repositories, status at a glance.
Editprofile Page
1. You can input or change your informations.
test installation
This is the usage just for the being. After cloning repository, type into terminal to automatically install modules and libraries.
npm install
To run server,
npm run dev:server
npm run dev:assets
Installation MongoDB
1. Access to the MongoDB homepage.
2. Select options and download MongoDB.
3. If this screen appears when installing MongoDB, please select 'complete' and proceed.
4. When you enter 'mongo' command in vsc terminal, it is installed well when the screen appears as below.
To setting environment variable.
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.
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'.
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'.
4. Create a new environmental variable path using the Mongo db address you copied earlier.
5. Please check if Mongo Db is working well in fourth method of "Installation MongoDB".
How to contribution our project.
1. Please fork our repository.
2. Change your branch to 'developer'.
3. Send pull request.
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.
API reference
\<!--GitHub Repositories API-->