최은석

Update README.md

Showing 1 changed file with 17 additions and 219 deletions
1 -# How to Install 1 +# 쿠돔카페 (KHU Dorm Cafeteria)
2 +
3 +## About the Project
4 +"쿠돔카페" 프로젝트
5 +1. 오늘 학식 메뉴와 요일별 학식 메뉴 안내
6 +2. 학식 대기시간 알려주기와 확인
7 +3. 학식과 관련한 게시물 작성과 수정, 삭제
8 +
9 +## Getting Started
10 +### How to Install
2 ``` 11 ```
3 npm install && cd client && npm install && cd ../ 12 npm install && cd client && npm install && cd ../
4 ``` 13 ```
5 - 14 +### How to Start
6 -# How to Start
7 ``` 15 ```
8 npm start 16 npm start
9 ``` 17 ```
...@@ -13,223 +21,13 @@ npm start ...@@ -13,223 +21,13 @@ npm start
13 > ``` 21 > ```
14 > 실행한뒤 다시 npm start 22 > 실행한뒤 다시 npm start
15 23
16 -# 학식 관련된 의견 주고 받는 커뮤니티 24 +## [DESIGN README](http://khuhub.khu.ac.kr/2021105655/ossw-project/tree/design)
17 -> 친구의 부탁으로 인해 현재 제2기숙사와 학생회관의 학식을 보여주는 앱을 개발했습니다.
18 -> 이와 관련된 반응을 에브리타임 앱에서 보고 있었습니다.
19 ->
20 -> 그러다가 자주 오늘의 학식이 맛있었는지 물어보는 질문글이나 오늘 맛이 어땠는지 알려주는 글도 자주 보인다는 것을 알게 되었습니다.
21 -> 하지만 에브리타임에는 다양한 글들이 올라오기 때문에 이와 같은 의견을 주고 받는 커뮤니티가 따로 있었으면 좋겠다는 생각이 들어서 개발하고자 하였습니다.
22 -> 물로 에브리타임에서 새로운 게시판을 만들어서 활용할 수 있지만 이번에 오픈소스 프로젝트에서 배운 것을 바탕으로 저희가 직접 만들어보는 것도 좋을 것 같다고 생각하여 시작하였습니다.
23 -> 이에 더 나아가 학식 업체 관계자들에게 저희 학생들이 주고 받는 의견이 어떠한지 알려주면서 더 좋은 학식을 기대하고 있습니다.
24 -
25 -## 필요한 페이지
26 -* 학식의 메뉴를 보여주는 페이지
27 -* 글과 사진을 올릴 수 있는 게시판 페이지
28 - ```1페이지 2페이지 이렇게 구분하는 것 대신 오늘의 메뉴에 관한 글, 어제의 메뉴에 관한글 이렇게 구분```
29 -* 글을 작성하는 페이지 ( 글을 수정할 수 있는 페이지 )
30 -* 관리자 페이지
31 -* 학식을 기다리는 줄이 현재 얼마나 긴지 알 수 있는 페이지
32 -
33 -## 예상 기능
34 -* 배달앱에서 리뷰를 할때 사진을 올리는 것 처럼 사진과 글을 같이 작성하는 기능
35 -* 카카오톡의 반응 기능이나 인스타의 좋아요 처럼 게시물에 이모티콘을 사용자가 표시하는 기능
36 - ```한 사용자가 여러번 남기는 것을 막아야 해서 로그인 기능 고려 필요```
37 -* 게시물 작성을 유도하기 위해 포인트 적립을 통해 랭킹 기능 고려
38 -* 작성된 글을 보기 쉽도록 게시글을 검색하는 기능
39 -
40 -# BACK
41 -## 게시물
42 -### /api/getList
43 -#### GET호출
44 -> response
45 -> ```
46 -> ["게시물 id1", "게시물 id2", "게시물 id3"]
47 ->```
48 ->> 오늘 게시물들의 아이디 표시
49 -
50 --------------
51 -### /api/getList/:date
52 -#### GET호출
53 -> response
54 -> ```
55 -> ["게시물 id1", "게시물 id2", "게시물 id3"]
56 ->```
57 ->> 특정 날자의 게시물들의 아이디 표시
58 -
59 --------------
60 -### /api/get
61 -#### GET호출
62 -> request(body)
63 -> ```
64 -> {
65 -> "idArray": ["게시물 id1", "게시물 id2", "게시물 id3"]
66 -> }
67 -> ```
68 25
69 -> response 26 +## [BACKEND README](http://khuhub.khu.ac.kr/2021105655/ossw-project/tree/back)
70 -> ```
71 -> [
72 -> {
73 -> "id": "게시물 id1",
74 -> "title": "제목1",
75 -> "content": "내용1"
76 -> },
77 -> {
78 -> "id": "게시물 id2",
79 -> "title": "제목2",
80 -> "content": "내용2"
81 -> },
82 -> {
83 -> "id": "게시물 id3",
84 -> "title": "제목3",
85 -> "content": "이 것은 긴 내용이..."
86 -> }
87 -> ]
88 -> ```
89 ->> 특정 id(여러개)의 게시물 내용 요약 불러오기
90 27
91 -------------- 28 +## [FRONTEND README](http://khuhub.khu.ac.kr/2021105655/ossw-project/tree/front)
92 -### /api/get/:id
93 -#### GET호출
94 -> response
95 -> ```
96 -> {
97 -> "title": "제목",
98 -> "content": "내용"
99 -> }
100 ->```
101 ->> 특정 id의 게시물 불러오기
102 29
103 -------------- 30 +## Contact
104 -### /api/isPassEqual 31 +채지성: jschae02@khu.ac.kr
105 -#### POST호출
106 -> request(body)
107 -> ```
108 -> {
109 -> "id":"게시물 id",
110 -> "password":"사용자가 입력한 암호"
111 -> }
112 -> ```
113 32
114 -> response 33 +최은석: ces21@khu.ac.kr
115 -> ```
116 -> success
117 -> ```
118 -> or
119 -> ```
120 -> failed
121 -> ```
122 ->
123 ->> 암호가 같으면 success, 아니면 failed
124 -
125 --------------
126 -### /api/postSave
127 -#### POST호출
128 -> request(body)
129 -> ```
130 -> {
131 -> "title":"제목",
132 -> "content":"게시물 내용",
133 -> "password":"암호"
134 -> }
135 -> ```
136 ->> 오늘 게시물 작성
137 -
138 --------------
139 -### /api/edit/:id
140 -#### POST호출
141 -> request(body)
142 -> ```
143 -> {
144 -> "title":"제목",
145 -> "content":"게시물 내용"
146 -> }
147 -> ```
148 ->> 오늘 게시물 수정
149 -
150 --------------
151 -### /api/delete/:id
152 -#### POST호출
153 ->> 오늘 게시물 삭제
154 -
155 -
156 -## 대기시간
157 -### /api/waiting
158 -#### GET호출
159 -> response
160 -> ```
161 -> [
162 -> {
163 -> "value": "대기시간1",
164 -> "time": "12:34"
165 -> }
166 -> ]
167 ->```
168 ->> 오늘의 대기시간 목록 가져오기
169 -
170 --------------
171 -### /api/waiting
172 -#### POST호출
173 -> request(body)
174 -> ```
175 -> {
176 -> "value":"대기시간2",
177 -> }
178 -> ```
179 -> response
180 -> ```
181 -> [
182 -> {
183 -> "value": "대기시간1",
184 -> "time": "12:34"
185 -> },
186 -> {
187 -> "value": "대기시간2",
188 -> "time": "13:57"
189 -> }
190 -> ]
191 ->```
192 ->> 오늘의 대기시간 추가
193 -
194 -## 제2기숙사 학식 메뉴
195 -### /api/menuList
196 -#### GET호출
197 -> response
198 -> ```
199 -> {
200 -> "fo_date": [
201 -> "2022-05-30",
202 -> "2022-05-31",
203 -> "2022-06-01",
204 -> "2022-06-02",
205 -> "2022-06-03"
206 -> ],
207 -> "fo_menu_lun": [
208 -> "도시락: 고추장불고기,근대된장국,도토리묵무침,미역줄기볶음,배추김치",
209 -> "도시락: 치즈함박스테이크,쇠고기스프,양상추샐러드,햄채소볶음밥,오이피클,배추김치",
210 -> "운영없음",
211 -> "도시락: 王소시지&카레라이스,다시마무챗국,만두튀김,단무지무침,배추김치",
212 -> "도시락: 돈까스마요덮밥,매운콩나물국,카레크로켓,마카로니샐러드,볶음김치"
213 -> ],
214 -> "fo_menu_eve": [
215 -> "도시락: 참치김치찌개,꼬마돈가스,돌자반볶음,단무지,쌀밥",
216 -> "도시락: 비빔우동&납작만두,유부장국,완자전,무말랭이무침,배추김치",
217 -> "운영없음",
218 -> "도시락: 치즈데리야끼불고기볶음밥,떡강정,양배추콘샐러드,배추김치,탄산음료",
219 -> "운영없음"
220 -> ]
221 -> }
222 ->```
223 ->> 제2기숙사 학식 메뉴 일주일치 가져오기
224 -
225 --------------
226 -### /api/todayMenu
227 -#### GET호출
228 -> response
229 -> ```
230 -> [
231 -> "도시락: 돈까스마요덮밥,매운콩나물국,카레크로켓,마카로니샐러드,볶음김치"
232 -> "운영없음"
233 -> ]
234 ->```
235 ->> 제2기숙사 학식 오늘의 메뉴 가져오기
......