송재혁

Merge branch 'addReadme' into 'master'

developed readme.md



See merge request !1
Showing 1 changed file with 21 additions and 4 deletions
# Jaksimsamil
## 마더프로젝트 url
http://khuhub.khu.ac.kr/MotherProject/Jaksimsamil
![issue badge](https://img.shields.io/github/issues/FacerAin/OSS-Jaksimsamil)
![fork badge](https://img.shields.io/github/forks/FacerAin/OSS-Jaksimsamil)
![star badge](https://img.shields.io/github/stars/FacerAin/OSS-Jaksimsamil)
......@@ -12,12 +15,14 @@
> 작심삼일 알고리즘 문제풀이 도우미 서비스<br/>
>
> > 알고리즘 문제 풀이 스터디를 꾸준히 할 수 있게 돕는 웹 서비스입니다.
> > <br> [링크](http://facerain.dcom.club)에서 직접 사용해 보세요!
> > <br> [링크](http://ossfinal.com)에서 직접 사용해 보세요!
![그림1](https://user-images.githubusercontent.com/16442978/85690047-236d1d00-b70e-11ea-8d2b-480593c0daf3.png)
![그림2](https://user-images.githubusercontent.com/16442978/85690058-2536e080-b70e-11ea-98cd-45fdf04084ce.png)
# 기존 프로젝트의 기능
## Features (ver.1.0.0)
- 회원가입/로그인 제공
......@@ -34,6 +39,10 @@
- 그룹 추천
- 개선된 문제 추천 (사용자 실력 맞춤형)
# 기존의 마더 프로젝트에 새롭게 추가한 기능
-카카오 api를 이용한 문제추천 알림
## Usages
#### 회원
......@@ -53,12 +62,19 @@
1. Clone
```
git clone https://github.com/FacerAin/OSS-Jaksimsamil.git
git clone http://khuhub.khu.ac.kr/2020-2_open_source_sw_development_Han/JaksimSamil_Develop.git
```
2. Install MongoDB(Ubuntu)
링크참조
https://docs.mongodb.com/manual/tutorial/install-mongodb-on-ubuntu/
```
wget -qO - https://www.mongodb.org/static/pgp/server-4.4.asc | sudo apt-key add -
sudo apt-get install gnupg
//ubuntu 18.04의 경우
echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu bionic/mongodb-org/4.4 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-4.4.list
sudo apt-get update
sudo apt-get install -y mongodb-org
sudo service mongod start
......@@ -73,12 +89,13 @@ touch .env
SERVER_PORT= ###
MONGO_URL= ###
JWT_SECRET= ###
KAKAO_JS_KEY = ###
```
4. Start Node Server
```
cd Jaksimsamil-server
cd jaksimsamil-server
sudo npm install
npm start
```
......@@ -89,7 +106,7 @@ npm start
5. Set Front-end page
```
cd Jaksimsamil-server
cd jaksimsamil-page
sudo npm install
npm start #Start React
```
......