Suyeon Jung

Update README

# 🏘 나의 동네는 살만한 곳일까?
# 🏘 어떤 동네가 좋은 동네일까?
## 🏡 Subject
현대인에게 있어 집 주변의 편의시설, 학군, 여가시설, 음식점 등은 매우 중요하다. 하지만 집을 알아볼 때 이를 직접 일일이 검색하며 알아봐야 하는 불편함이 있다.
현대인에게 있어 집 주변의 편의시설, 학군, 여가시설, 음식점 등은 매우 중요하다. 하지만 집을 알아볼 때 각 주소지별로 직접 일일이 검색하며 알아봐야 하는 불편함이 있다.
따라서 본 프로젝트에서는 사용자가 자신이 알아보고자 하는 주소를 입력하면 그 **주소에 기반하여 여러 카테고리(교통, 학군, 여가시설 등)에서의 점수**를 알려준다.
## 👫 Member
......@@ -9,15 +9,17 @@
* 컴퓨터공학과 이학주(2017104018)
* 컴퓨터공학과 정수연(2017104025)
## 💡Features
* 주소지 입력
* 주소에 해당하는 세권 측정
(음식, 학군, 공원, 대중교통, 교통, 안전, 여가 등)
## 📋 Manual
*미완성 단계에서의 페이지 스크린샷입니다.*
1. 주소지 입력
![검색 페이지](./public/img/demo_search.png)
1. 알고싶은 카테고리를 선택하여 검사
(음식, 학군, 공원, 대중교통, 안전, 여가, 쇼핑, 운동)
![카테고리 선택](public/img/demo_category.png)
## 🖥 Development
Node.js
Express
Pug
- Frontend : EJS
- Backend : Express
## 📑 API List
* Kakao Maps API
......@@ -34,28 +36,35 @@ Pug
* 경기도 내 공공체육시설 현황
* CCTV 현황
## 🗓History
*
## 🔌 Build
> **1. 프로젝트 디렉토리 생성**
## License
The MIT License (MIT)
```bash
$ mkdir [YOUR_APP_NAME]
$ cd [YOUR_APP_NAME]
```
> **2. repository clone 하기**
```bash
$ git clone http://khuhub.khu.ac.kr/zuzitsu/UR_Village.git
```
> **3. .env 파일 추가**
>> 1. /[YOUR_APP_NAME] 위치에서 `.env 파일`을 추가
>> 2. .env 파일에서 발급받은 Kakao api key, 경기데이터드림 api key 추가
>> [경기데이터드림](https://data.gg.go.kr/portal/intro/develop/searchBulletinPage.do),
>> [Kakao developers](https://developers.kakao.com/)
Copyright (c) 2020 zuzitsu
```
> KAKAO_APIKEY=[YOUR_API_KEY]
> GYEONGGI_APIKEY=[YOUR_API_KEY]
```
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
> **4. 실행**
```bash
$ npm install
$ npm start
```
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
> **4. `http://localhost:3000` 에 접속!**
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
\ No newline at end of file
## 📎 License
[MIT LICESNE](http://khuhub.khu.ac.kr/zuzitsu/UR_Village/blob/master/LICENSE)
......