YujeLee

README.md 수정

# Culture Gallery
## ✔ 목차
- [✔ 목차](#-목차)
- [📜 소개](#-소개)
- [개발 환경](#개발-환경)
- [사용한 API](#사용한-api)
- [🖥 설치 방법](#-설치-방법)
- [요구 사항](#요구-사항)
- [설치](#설치)
- [📖 사용 방법](#-사용-방법)
- [💁‍♂️ 기여하기](#️-기여하기)
- [© 라이센스](#-라이센스)
- [✉ 연락처](#-연락처)
## 📜 소개
![메인-화면](images/mainpage.jpg)
한국에서 진행하는 공연 중 본인에게 맞는 공연을 찾을 수 있는 서버입니다.<br>
본인 현재 위치 기반으로 주변에서 진행 하고있는 /진행 될 공연의 정보를 카카오 맵으로 제공합니다.<br>
기간/위치/비용 등의 필터를 통해 본인이 원하는 공연을 검색할 수 있습니다.<br>
카카오 계정 로그인을 통해 보러 가고 싶은 공연을 카카오톡 친구와 공유할 수 있는 기능을 제공합니다.
### 개발 환경
* [node.js - 14.15.1 LTS](https://nodejs.org/ko/)
* [Express - 4.17.1](https://expressjs.com/ko/)
* HTML5
* CSS3
### 사용한 API
* [Kakaomap Maps API](https://apis.map.kakao.com/)
* [Document](https://apis.map.kakao.com/web/documentation/)
* [Kakao Login API](https://developers.kakao.com/docs/latest/ko/kakaologin/common/)
* [Document](https://developers.kakao.com/docs/latest/ko/kakaologin/common)
## 🖥 설치 방법
서버 설치 방법을 소개합니다. 이 방법은 Local에서만 동작합니다.
### 요구 사항
* node.js
[링크](https://nodejs.org/ko/)에서 설치할 수 있습니다.
* npm
node.js와 함께 설치됩니다.
혹은 가장 최신 버전으로 업데이트합니다.
```sh
npm install -g npm
```
### 설치
1. [리포지토리](http://khuhub.khu.ac.kr/2019102210/CultureGallery) 클론
원하는 디렉토리에서 아래의 명령어를 입력해 이 리포지토리를 가져옵니다.
```
git clone http://khuhub.khu.ac.kr/2019102210/CultureGallery.git
```
2. npm 패키지 설치
서버 실행에 필요한 패키지를 설치합니다.
```
npm install
```
3. 포트 변경
www/bin에서 포트를 변경합니다. ( 기본값: 3000 )
```js
// www/bin
var port = normalizePort(process.env.PORT || 'Enter Your Port Here');
```
4. 서버 구동
터미널에서 npm start를 실행합니다.
```
npm start
```
## 📖 사용 방법
1. 크로미움 기반 웹 브라우저로 localhost:port에 접속합니다.
![메인-화면](images/mainpage.jpg)<br>
2. 나의 근처 공연/ 검색하기 / 로그인 버튼 중 하나를 선택합니다.<br>
-기능 1. 나의 근처 공연<br>
본인의 위치를 받아올 수 있도록 위치 수집 권한을 허락해주세요.<br>
지도 중심에 본인의 위치가 나오고 주변의 공연 장소에 마크가 달립니다.(보완 중)<br>
-기능 2. 검색하기<br>
원하는 필터를 체크한 후, 검색하면 해당 조건을 충족하는 공연들이 나옵니다.(개발 중)<br>
-기능 3. 로그인<br>
카카오톡 계정 로그인을 통해 더 많은 기능을 사용하세요!<br>
로그인을 하면 보러 가고 싶은 공연의 정보를 카카오톡 친구와 공유할 수 있습니다.<br>
## 💁‍♂️ 기여하기
이 프로젝트는 오픈소스입니다. 당신의 기여를 통해 이 프로젝트를 발전시켜 주세요.
## © 라이센스
MIT 라이센스를 따릅니다. 자세한 내용은 `License` 파일을 확인해주세요.
## ✉ 연락처
이유제: dbwp031@khu.ac.kr<br>
송효섭: crad_on25@khu.ac.kr<br>
\ No newline at end of file
This diff is collapsed. Click to expand it.