2020-2_open_source_sw_development_Han / Jaksimsamil

Go to a project
Toggle navigation Toggle navigation pinning
송용우
c222f2d2 1 parent 77480b1c

Update presentation file and readme

Inline Side-by-side
Showing 10 changed files with 68 additions and 45 deletions
......@@ -7,17 +7,18 @@
## Project Overview
> **Jaksaimsamil PS Helper service**
> **Jaksaimsamil Algorithm Study Helper Service**
>
> 작심삼일 알고리즘 문제풀이 도우미 서비스<br/>
>
> > 알고리즘 문제 풀이 스터디를 꾸준히 할 수 있게 돕는 웹 서비스입니다.
> > <br> [링크](http://facerain.dcom.club)에서 직접 사용해 보세요!
![그림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
## Features (ver.1.0.0)
- 회원가입/로그인 제공
- Online Judge 연동 가능 (Baekjoon)
......@@ -25,12 +26,27 @@
- 추천 문제 제공
- Slack 알리미
## Upcoming Features
- 친구 추가
- 친구와의 경쟁
- 그룹 추가
- 그룹 추천
- 개선된 문제 추천 (사용자 실력 맞춤형)
## Usages
1. Using Slack Notify
#### 회원
1. 로그인하여 서비스에 접속 할 수 있습니다.
2. 서비스가 처음이라면, 회원가입을 하세요.
<br>
- Go []
#### 설정
1. 백준 아이디를 등록하고 동기화하세요. [상세]()
2. 슬랙 HOOK URL을 등록하세요. [상세]()
3. 일일 목표량을 등록하세요.
## Getting Started
......@@ -64,9 +80,12 @@ JWT_SECRET= ###
```
cd Jaksimsamil-server
sudo npm install
node ./index.js #Start Server
npm start
```
[링크](/jaksimsamil-server/README.md)에서 API 제공 목록을 볼 수 있습니다.
<br>
5. Set Front-end page
```
......
# Jaksimsamil API Documentation
## Overview
- TBA
## URL
- TBA
## Usage
- TBA
## Example
- TBA
## API Table
| group | description | method | URL | Detail | Auth |
| ------- | --------------------------------- | ------ | ----------------------- | -------- | --------- |
| user | 유저 등록 | POST | api/user | 바로가기 | JWT Token |
| user | 유저 삭제 | DELETE | api/user:id | 바로가기 | JWT Token |
| user | 특정 유저 조회 | GET | api/user:id | 바로가기 | None |
| user | 전체 유저 조회 | GET | api/user | 바로가기 | JWT Token |
| friend | 유저 친구 등록 | POST | api/friend | 바로가기 | JWT Token |
| friend | 유저의 친구 조회 | GET | api/friend:id | 바로가기 | None |
| profile | 유저가 푼 문제 조회(백준) | GET | api/profile/solvedBJ:id | 바로가기 | None |
| profile | 유저가 푼 문제 동기화(백준) | PATCH | api/profile/syncBJ | 바로가기 | None |
| profile | 유저 정보 수정 | POST | api/profile/setprofile | 바로가기 | JWT TOKEN |
| profile | 유저 정보 받아오기 | POST | api/profile/getprofile | 바로가기 | JWT |
| profile | 추천 문제 조회 | POST | api/profile/recommend | 바로가기 | None |
| notify | 슬랙 메시지 전송 요청 (성취여부) | POST | api/notify/goal | 바로가기 | Jwt Token |
| notify | 슬랙 메시지 전송 요청 (문제 추천) | POST | api/notify/recommend | 바로가기 | None |
| auth | 로그인 | POST | api/auth/login | 바로가기 | None |
| auth | 로그아웃 | POST | api/auth/logout | 바로가기 | JWT Token |
| auth | 회원가입 | POST | api/auth/register | 바로가기 | None |
| auth | 로그인 확인 | GET | api/auth/check | 바로가기 | None |
# Jaksimsamil Server Documentation
## Overview
- KOA 프레임워크 기반의 REST-API로 동작합니다.
- API 문서는 아래를 참고해주세요.
## Usage
- Starting Server
```
npm install
npm update
node index.js
```
## Example
```
POST http://facerain.dcom.club/profile/getprofile
{
username: 'syw5141',
}
```
## API Table
| group | description | method | URL | Detail | Auth |
| ------- | -------------------------------------- | ------ | ----------------------- | -------------------------------------- | --------- |
| profile | 유저가 푼 문제 조회(백준) | GET | api/profile/solvedBJ:id | [바로가기](/src/api/profile/README.md) | None |
| profile | 유저가 푼 문제 동기화(백준) | PATCH | api/profile/syncBJ | [바로가기](/src/api/profile/README.md) | None |
| profile | 유저 정보 수정 | POST | api/profile/setprofile | [바로가기](/src/api/profile/README.md) | JWT TOKEN |
| profile | 유저 정보 받아오기 | POST | api/profile/getprofile | [바로가기](/src/api/profile/README.md) | JWT |
| profile | 추천 문제 조회 | POST | api/profile/recommend | [바로가기](/src/api/profile/README.md) | None |
| profile | 친구 추가 | POST | /api/profile/addfriend | [바로가기](/src/api/profile/README.md) | JWT TOKEN |
| notify | 슬랙 메시지 전송 요청 (목표 성취 여부) | POST | api/notify/goal | [바로가기](/src/api/notify/README.md) | Jwt Token |
| notify | 슬랙 메시지 전송 요청 (문제 추천) | POST | api/notify/recommend | [바로가기](/src/api/notify/README.md) | None |
| auth | 로그인 | POST | api/auth/login | [바로가기](/src/api/auth/README.md) | None |
| auth | 로그아웃 | POST | api/auth/logout | [바로가기](/src/api/auth/README.md) | JWT Token |
| auth | 회원가입 | POST | api/auth/register | [바로가기](/src/api/auth/README.md) | None |
| auth | 로그인 확인 | GET | api/auth/check | [바로가기](/src/api/auth/README.md) | None |
......@@ -33,7 +33,7 @@
"nodemon": "^2.0.4"
},
"scripts": {
"start": "node src",
"start": "node ./index.js",
"start:dev": "nodemon --watch src/ src/index.js"
}
}
......