최은석

Update README.md

Showing 1 changed file with 17 additions and 219 deletions
# How to Install
# 쿠돔카페 (KHU Dorm Cafeteria)
## About the Project
"쿠돔카페" 프로젝트
1. 오늘 학식 메뉴와 요일별 학식 메뉴 안내
2. 학식 대기시간 알려주기와 확인
3. 학식과 관련한 게시물 작성과 수정, 삭제
## Getting Started
### How to Install
```
npm install && cd client && npm install && cd ../
```
# How to Start
### How to Start
```
npm start
```
......@@ -13,223 +21,13 @@ npm start
> ```
> 실행한뒤 다시 npm start
# 학식 관련된 의견 주고 받는 커뮤니티
> 친구의 부탁으로 인해 현재 제2기숙사와 학생회관의 학식을 보여주는 앱을 개발했습니다.
> 이와 관련된 반응을 에브리타임 앱에서 보고 있었습니다.
>
> 그러다가 자주 오늘의 학식이 맛있었는지 물어보는 질문글이나 오늘 맛이 어땠는지 알려주는 글도 자주 보인다는 것을 알게 되었습니다.
> 하지만 에브리타임에는 다양한 글들이 올라오기 때문에 이와 같은 의견을 주고 받는 커뮤니티가 따로 있었으면 좋겠다는 생각이 들어서 개발하고자 하였습니다.
> 물로 에브리타임에서 새로운 게시판을 만들어서 활용할 수 있지만 이번에 오픈소스 프로젝트에서 배운 것을 바탕으로 저희가 직접 만들어보는 것도 좋을 것 같다고 생각하여 시작하였습니다.
> 이에 더 나아가 학식 업체 관계자들에게 저희 학생들이 주고 받는 의견이 어떠한지 알려주면서 더 좋은 학식을 기대하고 있습니다.
## 필요한 페이지
* 학식의 메뉴를 보여주는 페이지
* 글과 사진을 올릴 수 있는 게시판 페이지
```1페이지 2페이지 이렇게 구분하는 것 대신 오늘의 메뉴에 관한 글, 어제의 메뉴에 관한글 이렇게 구분```
* 글을 작성하는 페이지 ( 글을 수정할 수 있는 페이지 )
* 관리자 페이지
* 학식을 기다리는 줄이 현재 얼마나 긴지 알 수 있는 페이지
## 예상 기능
* 배달앱에서 리뷰를 할때 사진을 올리는 것 처럼 사진과 글을 같이 작성하는 기능
* 카카오톡의 반응 기능이나 인스타의 좋아요 처럼 게시물에 이모티콘을 사용자가 표시하는 기능
```한 사용자가 여러번 남기는 것을 막아야 해서 로그인 기능 고려 필요```
* 게시물 작성을 유도하기 위해 포인트 적립을 통해 랭킹 기능 고려
* 작성된 글을 보기 쉽도록 게시글을 검색하는 기능
# BACK
## 게시물
### /api/getList
#### GET호출
> response
> ```
> ["게시물 id1", "게시물 id2", "게시물 id3"]
>```
>> 오늘 게시물들의 아이디 표시
-------------
### /api/getList/:date
#### GET호출
> response
> ```
> ["게시물 id1", "게시물 id2", "게시물 id3"]
>```
>> 특정 날자의 게시물들의 아이디 표시
-------------
### /api/get
#### GET호출
> request(body)
> ```
> {
> "idArray": ["게시물 id1", "게시물 id2", "게시물 id3"]
> }
> ```
## [DESIGN README](http://khuhub.khu.ac.kr/2021105655/ossw-project/tree/design)
> response
> ```
> [
> {
> "id": "게시물 id1",
> "title": "제목1",
> "content": "내용1"
> },
> {
> "id": "게시물 id2",
> "title": "제목2",
> "content": "내용2"
> },
> {
> "id": "게시물 id3",
> "title": "제목3",
> "content": "이 것은 긴 내용이..."
> }
> ]
> ```
>> 특정 id(여러개)의 게시물 내용 요약 불러오기
## [BACKEND README](http://khuhub.khu.ac.kr/2021105655/ossw-project/tree/back)
-------------
### /api/get/:id
#### GET호출
> response
> ```
> {
> "title": "제목",
> "content": "내용"
> }
>```
>> 특정 id의 게시물 불러오기
## [FRONTEND README](http://khuhub.khu.ac.kr/2021105655/ossw-project/tree/front)
-------------
### /api/isPassEqual
#### POST호출
> request(body)
> ```
> {
> "id":"게시물 id",
> "password":"사용자가 입력한 암호"
> }
> ```
## Contact
채지성: jschae02@khu.ac.kr
> response
> ```
> success
> ```
> or
> ```
> failed
> ```
>
>> 암호가 같으면 success, 아니면 failed
-------------
### /api/postSave
#### POST호출
> request(body)
> ```
> {
> "title":"제목",
> "content":"게시물 내용",
> "password":"암호"
> }
> ```
>> 오늘 게시물 작성
-------------
### /api/edit/:id
#### POST호출
> request(body)
> ```
> {
> "title":"제목",
> "content":"게시물 내용"
> }
> ```
>> 오늘 게시물 수정
-------------
### /api/delete/:id
#### POST호출
>> 오늘 게시물 삭제
## 대기시간
### /api/waiting
#### GET호출
> response
> ```
> [
> {
> "value": "대기시간1",
> "time": "12:34"
> }
> ]
>```
>> 오늘의 대기시간 목록 가져오기
-------------
### /api/waiting
#### POST호출
> request(body)
> ```
> {
> "value":"대기시간2",
> }
> ```
> response
> ```
> [
> {
> "value": "대기시간1",
> "time": "12:34"
> },
> {
> "value": "대기시간2",
> "time": "13:57"
> }
> ]
>```
>> 오늘의 대기시간 추가
## 제2기숙사 학식 메뉴
### /api/menuList
#### GET호출
> response
> ```
> {
> "fo_date": [
> "2022-05-30",
> "2022-05-31",
> "2022-06-01",
> "2022-06-02",
> "2022-06-03"
> ],
> "fo_menu_lun": [
> "도시락: 고추장불고기,근대된장국,도토리묵무침,미역줄기볶음,배추김치",
> "도시락: 치즈함박스테이크,쇠고기스프,양상추샐러드,햄채소볶음밥,오이피클,배추김치",
> "운영없음",
> "도시락: 王소시지&카레라이스,다시마무챗국,만두튀김,단무지무침,배추김치",
> "도시락: 돈까스마요덮밥,매운콩나물국,카레크로켓,마카로니샐러드,볶음김치"
> ],
> "fo_menu_eve": [
> "도시락: 참치김치찌개,꼬마돈가스,돌자반볶음,단무지,쌀밥",
> "도시락: 비빔우동&납작만두,유부장국,완자전,무말랭이무침,배추김치",
> "운영없음",
> "도시락: 치즈데리야끼불고기볶음밥,떡강정,양배추콘샐러드,배추김치,탄산음료",
> "운영없음"
> ]
> }
>```
>> 제2기숙사 학식 메뉴 일주일치 가져오기
-------------
### /api/todayMenu
#### GET호출
> response
> ```
> [
> "도시락: 돈까스마요덮밥,매운콩나물국,카레크로켓,마카로니샐러드,볶음김치"
> "운영없음"
> ]
>```
>> 제2기숙사 학식 오늘의 메뉴 가져오기
최은석: ces21@khu.ac.kr
......