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 @@ ...@@ -7,17 +7,18 @@
7 7
8 ## Project Overview 8 ## Project Overview
9 9
10 -> **Jaksaimsamil PS Helper service** 10 +> **Jaksaimsamil Algorithm Study Helper Service**
11 > 11 >
12 > 작심삼일 알고리즘 문제풀이 도우미 서비스<br/> 12 > 작심삼일 알고리즘 문제풀이 도우미 서비스<br/>
13 > 13 >
14 > > 알고리즘 문제 풀이 스터디를 꾸준히 할 수 있게 돕는 웹 서비스입니다. 14 > > 알고리즘 문제 풀이 스터디를 꾸준히 할 수 있게 돕는 웹 서비스입니다.
15 +> > <br> [링크](http://facerain.dcom.club)에서 직접 사용해 보세요!
15 16
16 ![그림1](https://user-images.githubusercontent.com/16442978/85690047-236d1d00-b70e-11ea-8d2b-480593c0daf3.png) 17 ![그림1](https://user-images.githubusercontent.com/16442978/85690047-236d1d00-b70e-11ea-8d2b-480593c0daf3.png)
17 18
18 ![그림2](https://user-images.githubusercontent.com/16442978/85690058-2536e080-b70e-11ea-98cd-45fdf04084ce.png) 19 ![그림2](https://user-images.githubusercontent.com/16442978/85690058-2536e080-b70e-11ea-98cd-45fdf04084ce.png)
19 20
20 -## Features 21 +## Features (ver.1.0.0)
21 22
22 - 회원가입/로그인 제공 23 - 회원가입/로그인 제공
23 - Online Judge 연동 가능 (Baekjoon) 24 - Online Judge 연동 가능 (Baekjoon)
...@@ -25,12 +26,27 @@ ...@@ -25,12 +26,27 @@
25 - 추천 문제 제공 26 - 추천 문제 제공
26 - Slack 알리미 27 - Slack 알리미
27 28
29 +## Upcoming Features
30 +
31 +- 친구 추가
32 +- 친구와의 경쟁
33 +- 그룹 추가
34 +- 그룹 추천
35 +- 개선된 문제 추천 (사용자 실력 맞춤형)
36 +
28 ## Usages 37 ## Usages
29 38
30 -1. Using Slack Notify 39 +#### 회원
40 +
41 +1. 로그인하여 서비스에 접속 할 수 있습니다.
42 +2. 서비스가 처음이라면, 회원가입을 하세요.
31 <br> 43 <br>
32 44
33 -- Go [] 45 +#### 설정
46 +
47 +1. 백준 아이디를 등록하고 동기화하세요. [상세]()
48 +2. 슬랙 HOOK URL을 등록하세요. [상세]()
49 +3. 일일 목표량을 등록하세요.
34 50
35 ## Getting Started 51 ## Getting Started
36 52
...@@ -64,9 +80,12 @@ JWT_SECRET= ### ...@@ -64,9 +80,12 @@ JWT_SECRET= ###
64 ``` 80 ```
65 cd Jaksimsamil-server 81 cd Jaksimsamil-server
66 sudo npm install 82 sudo npm install
67 -node ./index.js #Start Server 83 +npm start
68 ``` 84 ```
69 85
86 +[링크](/jaksimsamil-server/README.md)에서 API 제공 목록을 볼 수 있습니다.
87 +<br>
88 +
70 5. Set Front-end page 89 5. Set Front-end page
71 90
72 ``` 91 ```
......
1 -# Jaksimsamil API Documentation
2 -
3 -## Overview
4 -
5 -- TBA
6 -
7 -## URL
8 -
9 -- TBA
10 -
11 -## Usage
12 -
13 -- TBA
14 -
15 -## Example
16 -
17 -- TBA
18 -
19 -## API Table
20 -
21 -| group | description | method | URL | Detail | Auth |
22 -| ------- | --------------------------------- | ------ | ----------------------- | -------- | --------- |
23 -| user | 유저 등록 | POST | api/user | 바로가기 | JWT Token |
24 -| user | 유저 삭제 | DELETE | api/user:id | 바로가기 | JWT Token |
25 -| user | 특정 유저 조회 | GET | api/user:id | 바로가기 | None |
26 -| user | 전체 유저 조회 | GET | api/user | 바로가기 | JWT Token |
27 -| friend | 유저 친구 등록 | POST | api/friend | 바로가기 | JWT Token |
28 -| friend | 유저의 친구 조회 | GET | api/friend:id | 바로가기 | None |
29 -| profile | 유저가 푼 문제 조회(백준) | GET | api/profile/solvedBJ:id | 바로가기 | None |
30 -| profile | 유저가 푼 문제 동기화(백준) | PATCH | api/profile/syncBJ | 바로가기 | None |
31 -| profile | 유저 정보 수정 | POST | api/profile/setprofile | 바로가기 | JWT TOKEN |
32 -| profile | 유저 정보 받아오기 | POST | api/profile/getprofile | 바로가기 | JWT |
33 -| profile | 추천 문제 조회 | POST | api/profile/recommend | 바로가기 | None |
34 -| notify | 슬랙 메시지 전송 요청 (성취여부) | POST | api/notify/goal | 바로가기 | Jwt Token |
35 -| notify | 슬랙 메시지 전송 요청 (문제 추천) | POST | api/notify/recommend | 바로가기 | None |
36 -| auth | 로그인 | POST | api/auth/login | 바로가기 | None |
37 -| auth | 로그아웃 | POST | api/auth/logout | 바로가기 | JWT Token |
38 -| auth | 회원가입 | POST | api/auth/register | 바로가기 | None |
39 -| auth | 로그인 확인 | GET | api/auth/check | 바로가기 | None |
1 +# Jaksimsamil Server Documentation
2 +
3 +## Overview
4 +
5 +- KOA 프레임워크 기반의 REST-API로 동작합니다.
6 +- API 문서는 아래를 참고해주세요.
7 +
8 +## Usage
9 +
10 +- Starting Server
11 +
12 +```
13 +npm install
14 +npm update
15 +node index.js
16 +```
17 +
18 +## Example
19 +
20 +```
21 +POST http://facerain.dcom.club/profile/getprofile
22 +{
23 + username: 'syw5141',
24 +}
25 +```
26 +
27 +## API Table
28 +
29 +| group | description | method | URL | Detail | Auth |
30 +| ------- | -------------------------------------- | ------ | ----------------------- | -------------------------------------- | --------- |
31 +| profile | 유저가 푼 문제 조회(백준) | GET | api/profile/solvedBJ:id | [바로가기](/src/api/profile/README.md) | None |
32 +| profile | 유저가 푼 문제 동기화(백준) | PATCH | api/profile/syncBJ | [바로가기](/src/api/profile/README.md) | None |
33 +| profile | 유저 정보 수정 | POST | api/profile/setprofile | [바로가기](/src/api/profile/README.md) | JWT TOKEN |
34 +| profile | 유저 정보 받아오기 | POST | api/profile/getprofile | [바로가기](/src/api/profile/README.md) | JWT |
35 +| profile | 추천 문제 조회 | POST | api/profile/recommend | [바로가기](/src/api/profile/README.md) | None |
36 +| profile | 친구 추가 | POST | /api/profile/addfriend | [바로가기](/src/api/profile/README.md) | JWT TOKEN |
37 +| notify | 슬랙 메시지 전송 요청 (목표 성취 여부) | POST | api/notify/goal | [바로가기](/src/api/notify/README.md) | Jwt Token |
38 +| notify | 슬랙 메시지 전송 요청 (문제 추천) | POST | api/notify/recommend | [바로가기](/src/api/notify/README.md) | None |
39 +| auth | 로그인 | POST | api/auth/login | [바로가기](/src/api/auth/README.md) | None |
40 +| auth | 로그아웃 | POST | api/auth/logout | [바로가기](/src/api/auth/README.md) | JWT Token |
41 +| auth | 회원가입 | POST | api/auth/register | [바로가기](/src/api/auth/README.md) | None |
42 +| auth | 로그인 확인 | GET | api/auth/check | [바로가기](/src/api/auth/README.md) | None |
...@@ -33,7 +33,7 @@ ...@@ -33,7 +33,7 @@
33 "nodemon": "^2.0.4" 33 "nodemon": "^2.0.4"
34 }, 34 },
35 "scripts": { 35 "scripts": {
36 - "start": "node src", 36 + "start": "node ./index.js",
37 "start:dev": "nodemon --watch src/ src/index.js" 37 "start:dev": "nodemon --watch src/ src/index.js"
38 } 38 }
39 } 39 }
......