김대철 / CafeRecommend

Go to a project
Toggle navigation Toggle navigation pinning
김대철
6e3b0c01 1 parent b21153d1

Update README.md

Inline Side-by-side
Showing 1 changed file with 125 additions and 71 deletions
###초기설정
> ####데이터 베이스 설정
>
> <pre><code>
> CREATE TABLE USER(
> ID int(10) NOT NULL AUTO_INCREMENT PRIMARY KEY,
> EMAIL varchar(64) NOT NULL UNIQUE,
> NICKNAME varchar(32) UNIQUE,
> AGE int(16),
> GENDER varchar(32)
> );
> </code>
</pre>
> <pre><code>
> CREATE TABLE REVIEW(
> ID int(10) NOT NULL AUTO_INCREMENT PRIMARY KEY,
> CAFE_ID int(10) NOT NULL,
> PRICE int(10) NOT NULL,
> KINDNESS int(10) NOT NULL,
> NOISE int(10) NOT NULL,
> ACCESSIBILITY int(10) NOT NULL
> );
> </code>
</pre>
> <pre><code>
> CREATE TABLE PREFERENCE(
> ID int(10) NOT NULL AUTO_INCREMENT PRIMARY KEY,
> NICKNAME varchar(32) NOT NULL UNIQUE,
> PRICE int(10) NOT NULL,
> KINDNESS int(10) NOT NULL,
> NOISE int(10) NOT NULL,
> ACCESSIBILITY int(10) NOT NULL
> FOREIGN KEY(NICKNAME) REFERENCES USER(NICKNAME) ON DELETE CASCADE
> );
> </code>
</pre>
###commit 형식
<pre><code>
##### 제목 - 50자 이내로 요약!
### [커밋 타입]: [작업내용]
##### 본문 - 한 줄에 최대 72 글자까지만 입력하기
# 1. 무엇을 수정했는지
# 2. 왜 수정했는지
# 꼬릿말은 아래에 작성: ex) #이슈 번호
-
# [커밋 타입] 리스트
# feat : 기능 (새로운 기능)
# fix : 버그 (버그 수정)
# refactor : 리팩토링
# style : 스타일 (코드 형식, 세미콜론 추가: 비즈니스 로직에 변경 없음)
# docs : 문서 (문서 추가, 수정, 삭제)
# test : 테스트 (테스트 코드 추가, 수정, 삭제: 비즈니스 로직에 변경 없음)
# chore : 기타 변경사항 (빌드 스크립트 수정 등)
# post : 블로그 포스트 추가 (신규 포스트 작성 및 수정)
# ------------------
# [체크리스트]
# 제목 첫 글자는 대문자로 작성했나요?
</code>
</pre>
# CafeRecommend
<!-- TABLE OF CONTENTS -->
<h2>목차</h2>
<ol>
<li>
<a href="#about-the-project">About the Project</a>
</li>
<li>
<a href="#demo-link">Demo Link</a>
</li>
<li>
<a href="#getting-started">Getting Started</a>
<ul>
<li><a href="#prerequisite">Prerequisite</a></li>
<li><a href="#execution">Execution</a></li>
</ul>
</li>
<li><a href="#usage">Usage</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#contact">Contact</a></li>
</ol>
<!-- ABOUT THE PROJECT -->
## About The Project
![Capture](http://khuhub.khu.ac.kr/2015104153/CafeRecommend/uploads/bcc05b19d802e109e080a9fd8fd0a629/Capture.JPG)
카카오 지도 API를 활용하여 사용자가 원하는 카페들을 지도상에서 추천해주는 서비스 입니다.
<!-- DEMO LINK -->
## Demo Link
https://2015104153.oss2021.tk:3000
<!-- GETTING STARTED -->
## Getting Started
### Prerequisite
* <a href="https://nodejs.org/ko/">Node.js</a>
* <a href="https://www.mysql.com/">MySQL</a>
* <a href="https://aws.amazon.com/ko/?nc2=h_lg">AWS</a>
### Execution
1. 구글 클라우드 생성 및 프로젝트 등록 후 ClientID 발급 (https://cloud.google.com/)
2. 카카오 Developer 가입 후 애플리케이션 추가 후 Javascript API키 발급 (https://developers.kakao.com/)
3. sql폴더에 정의된 테이블 생성문 MySQL에서 실행
4. KHU-HUB repo clone
```sh
git clone http://khuhub.khu.ac.kr/2015104153/CafeRecommend
```
5. 디렉토리 이동 후 npm 패키지 설치
```sh
npm install
```
6. 발급받은 ClientID를 `index.js`, `index.ejs`, Javascript API키는 `map.ejs`에 각각 넣기
```JS
var CLIENT_ID = "발급받은 ClientID" // index.js
```
```HTML
<meta name="google-signin-client_id" content="발급받은 ClientID"> // index.ejs
```
```HTML
<script type="text/javascript" src="//dapi.kakao.com/v2/maps/sdk.js?appkey=발급받은API키&libraries=services"></script> // map.ejs
```
7. MySQL connection 연결 설정 (index.js)
```JS
var connection = mysql.createConnection({
host: "IP주소 입력 (localhost 또는 AWS 서버 주소)",
user: "계정 입력",
password: "암호 입력",
database: "스키마이름 입력",
});
```
8. 프로그램 실행
```sh
npm run start
```
<!-- USAGE -->
## Usage
### Login & SignUp
프로그램 실행 시 최초에 나타나는 화면입니다. 구글 로그인 버튼 클릭 시에는 구글계정으로만 로그인을 수행합니다. 계정이 등록된 경우에는
바로 Map 화면으로 이동하며 그렇지 않은 경우 회원가입화면에서 닉네임(중복 불가), 나이, 성별입력 및 선호도를 선택을 수행합니다.
### Map
프로젝트 메인 화면입니다. 지도에 줌인.줌아웃이 가능하며 초기에는 사용자의 현재 위치를 기준으로 위치로 이동합니다.
API를 통해 제공된 45개의 카페가 마커형태로 나타나며 클릭 시 상세정보를 보여줍니다. 이때 후기등록 버튼 클릭시에는 후기 등록 화면으로 이동합니다.
### Review
후기입력화면입니다. 총 4가지를 1~5점 범위에서 입력받습니다. 4가지를 모두 입력받아야 하며 등록 완료시에는 alert메시지가 나오고 Map화면으로 돌아갑니다.
### Recommend
Map에서 화면 하단의 추천 버튼 클릭 시 나타나는 화면입니다. 추천 버튼을 클릭하면 가입 시 선택했던 선호도에 맞는 카페만을 지도에 보여줍니다.
이때 추천 결과가 없는 경우에는 추천을 수행하지 않고 모든 카페를 보여줍니다.
<!-- CONTRIBUTING -->
## Contributing
1. 프로젝트 Fork
2. 브랜치 생성 후 변경사항 작업
3. 브랜치 push 후 Pull Request Open
<!-- CONTACT -->
## Contact
2015104153 김대철
<a href="https://github.com/dckat">Github Link</a>
2016104174 최정민
<a href="https://github.com/cjm2021401">Github Link</a>
......