Showing
1 changed file
with
125 additions
and
71 deletions
1 | -###초기설정 | 1 | +# CafeRecommend |
2 | - | 2 | + |
3 | -> ####데이터 베이스 설정 | 3 | +<!-- TABLE OF CONTENTS --> |
4 | -> | 4 | +<h2>목차</h2> |
5 | -> <pre><code> | 5 | +<ol> |
6 | -> CREATE TABLE USER( | 6 | + <li> |
7 | -> ID int(10) NOT NULL AUTO_INCREMENT PRIMARY KEY, | 7 | + <a href="#about-the-project">About the Project</a> |
8 | -> EMAIL varchar(64) NOT NULL UNIQUE, | 8 | + </li> |
9 | -> NICKNAME varchar(32) UNIQUE, | 9 | + <li> |
10 | -> AGE int(16), | 10 | + <a href="#demo-link">Demo Link</a> |
11 | -> GENDER varchar(32) | 11 | + </li> |
12 | -> ); | 12 | + <li> |
13 | -> </code> | 13 | + <a href="#getting-started">Getting Started</a> |
14 | - | 14 | + <ul> |
15 | -</pre> | 15 | + <li><a href="#prerequisite">Prerequisite</a></li> |
16 | - | 16 | + <li><a href="#execution">Execution</a></li> |
17 | -> <pre><code> | 17 | + </ul> |
18 | -> CREATE TABLE REVIEW( | 18 | + </li> |
19 | -> ID int(10) NOT NULL AUTO_INCREMENT PRIMARY KEY, | 19 | + <li><a href="#usage">Usage</a></li> |
20 | -> CAFE_ID int(10) NOT NULL, | 20 | + <li><a href="#contributing">Contributing</a></li> |
21 | -> PRICE int(10) NOT NULL, | 21 | + <li><a href="#contact">Contact</a></li> |
22 | -> KINDNESS int(10) NOT NULL, | 22 | +</ol> |
23 | -> NOISE int(10) NOT NULL, | 23 | + |
24 | -> ACCESSIBILITY int(10) NOT NULL | 24 | + |
25 | -> ); | 25 | +<!-- ABOUT THE PROJECT --> |
26 | -> </code> | 26 | +## About The Project |
27 | - | 27 | + |
28 | -</pre> | 28 | +![Capture](http://khuhub.khu.ac.kr/2015104153/CafeRecommend/uploads/bcc05b19d802e109e080a9fd8fd0a629/Capture.JPG) |
29 | - | 29 | + |
30 | -> <pre><code> | 30 | +카카오 지도 API를 활용하여 사용자가 원하는 카페들을 지도상에서 추천해주는 서비스 입니다. |
31 | -> CREATE TABLE PREFERENCE( | 31 | + |
32 | -> ID int(10) NOT NULL AUTO_INCREMENT PRIMARY KEY, | 32 | +<!-- DEMO LINK --> |
33 | -> NICKNAME varchar(32) NOT NULL UNIQUE, | 33 | +## Demo Link |
34 | -> PRICE int(10) NOT NULL, | 34 | +https://2015104153.oss2021.tk:3000 |
35 | -> KINDNESS int(10) NOT NULL, | 35 | + |
36 | -> NOISE int(10) NOT NULL, | 36 | + |
37 | -> ACCESSIBILITY int(10) NOT NULL | 37 | +<!-- GETTING STARTED --> |
38 | -> FOREIGN KEY(NICKNAME) REFERENCES USER(NICKNAME) ON DELETE CASCADE | 38 | +## Getting Started |
39 | -> ); | 39 | + |
40 | -> </code> | 40 | +### Prerequisite |
41 | - | 41 | +* <a href="https://nodejs.org/ko/">Node.js</a> |
42 | -</pre> | 42 | + |
43 | - | 43 | + |
44 | -###commit 형식 | 44 | +* <a href="https://www.mysql.com/">MySQL</a> |
45 | - | 45 | + |
46 | -<pre><code> | 46 | + |
47 | -##### 제목 - 50자 이내로 요약! | 47 | +* <a href="https://aws.amazon.com/ko/?nc2=h_lg">AWS</a> |
48 | - | 48 | + |
49 | -### [커밋 타입]: [작업내용] | 49 | + |
50 | - | 50 | + |
51 | -##### 본문 - 한 줄에 최대 72 글자까지만 입력하기 | 51 | +### Execution |
52 | - | 52 | + |
53 | -# 1. 무엇을 수정했는지 | 53 | +1. 구글 클라우드 생성 및 프로젝트 등록 후 ClientID 발급 (https://cloud.google.com/) |
54 | -# 2. 왜 수정했는지 | 54 | +2. 카카오 Developer 가입 후 애플리케이션 추가 후 Javascript API키 발급 (https://developers.kakao.com/) |
55 | - | 55 | +3. sql폴더에 정의된 테이블 생성문 MySQL에서 실행 |
56 | -# 꼬릿말은 아래에 작성: ex) #이슈 번호 | 56 | +4. KHU-HUB repo clone |
57 | -- | 57 | + ```sh |
58 | -# [커밋 타입] 리스트 | 58 | + git clone http://khuhub.khu.ac.kr/2015104153/CafeRecommend |
59 | -# feat : 기능 (새로운 기능) | 59 | + ``` |
60 | -# fix : 버그 (버그 수정) | 60 | +5. 디렉토리 이동 후 npm 패키지 설치 |
61 | -# refactor : 리팩토링 | 61 | + ```sh |
62 | -# style : 스타일 (코드 형식, 세미콜론 추가: 비즈니스 로직에 변경 없음) | 62 | + npm install |
63 | -# docs : 문서 (문서 추가, 수정, 삭제) | 63 | + ``` |
64 | -# test : 테스트 (테스트 코드 추가, 수정, 삭제: 비즈니스 로직에 변경 없음) | 64 | +6. 발급받은 ClientID를 `index.js`, `index.ejs`, Javascript API키는 `map.ejs`에 각각 넣기 |
65 | -# chore : 기타 변경사항 (빌드 스크립트 수정 등) | 65 | + ```JS |
66 | -# post : 블로그 포스트 추가 (신규 포스트 작성 및 수정) | 66 | + var CLIENT_ID = "발급받은 ClientID" // index.js |
67 | -# ------------------ | 67 | + ``` |
68 | -# [체크리스트] | 68 | + |
69 | -# 제목 첫 글자는 대문자로 작성했나요? | 69 | + ```HTML |
70 | -</code> | 70 | + <meta name="google-signin-client_id" content="발급받은 ClientID"> // index.ejs |
71 | -</pre> | 71 | + ``` |
72 | + | ||
73 | + ```HTML | ||
74 | + <script type="text/javascript" src="//dapi.kakao.com/v2/maps/sdk.js?appkey=발급받은API키&libraries=services"></script> // map.ejs | ||
75 | + ``` | ||
76 | +7. MySQL connection 연결 설정 (index.js) | ||
77 | + ```JS | ||
78 | + var connection = mysql.createConnection({ | ||
79 | + host: "IP주소 입력 (localhost 또는 AWS 서버 주소)", | ||
80 | + user: "계정 입력", | ||
81 | + password: "암호 입력", | ||
82 | + database: "스키마이름 입력", | ||
83 | + }); | ||
84 | + ``` | ||
85 | +8. 프로그램 실행 | ||
86 | + ```sh | ||
87 | + npm run start | ||
88 | + ``` | ||
89 | + | ||
90 | +<!-- USAGE --> | ||
91 | +## Usage | ||
92 | + | ||
93 | +### Login & SignUp | ||
94 | +프로그램 실행 시 최초에 나타나는 화면입니다. 구글 로그인 버튼 클릭 시에는 구글계정으로만 로그인을 수행합니다. 계정이 등록된 경우에는 | ||
95 | +바로 Map 화면으로 이동하며 그렇지 않은 경우 회원가입화면에서 닉네임(중복 불가), 나이, 성별입력 및 선호도를 선택을 수행합니다. | ||
96 | +### Map | ||
97 | +프로젝트 메인 화면입니다. 지도에 줌인.줌아웃이 가능하며 초기에는 사용자의 현재 위치를 기준으로 위치로 이동합니다. | ||
98 | +API를 통해 제공된 45개의 카페가 마커형태로 나타나며 클릭 시 상세정보를 보여줍니다. 이때 후기등록 버튼 클릭시에는 후기 등록 화면으로 이동합니다. | ||
99 | +### Review | ||
100 | +후기입력화면입니다. 총 4가지를 1~5점 범위에서 입력받습니다. 4가지를 모두 입력받아야 하며 등록 완료시에는 alert메시지가 나오고 Map화면으로 돌아갑니다. | ||
101 | +### Recommend | ||
102 | +Map에서 화면 하단의 추천 버튼 클릭 시 나타나는 화면입니다. 추천 버튼을 클릭하면 가입 시 선택했던 선호도에 맞는 카페만을 지도에 보여줍니다. | ||
103 | +이때 추천 결과가 없는 경우에는 추천을 수행하지 않고 모든 카페를 보여줍니다. | ||
104 | + | ||
105 | +<!-- CONTRIBUTING --> | ||
106 | +## Contributing | ||
107 | + | ||
108 | +1. 프로젝트 Fork | ||
109 | +2. 브랜치 생성 후 변경사항 작업 | ||
110 | +3. 브랜치 push 후 Pull Request Open | ||
111 | + | ||
112 | +<!-- CONTACT --> | ||
113 | +## Contact | ||
114 | + | ||
115 | +2015104153 김대철 | ||
116 | + | ||
117 | + | ||
118 | + <a href="https://github.com/dckat">Github Link</a> | ||
119 | + | ||
120 | + | ||
121 | +2016104174 최정민 | ||
122 | + | ||
123 | + | ||
124 | + <a href="https://github.com/cjm2021401">Github Link</a> | ||
125 | + | ... | ... |
-
Please register or login to post a comment