zuzitsu / UR_Village

Go to a project
Toggle navigation Toggle navigation pinning
정수연
dca62ce1 1 parent 8e653ea5

Update README.md

Inline Side-by-side
Showing 1 changed file with 11 additions and 9 deletions
1 # 🏘 어떤 동네가 좋은 동네일까? 1 # 🏘 어떤 동네가 좋은 동네일까?
2 2
3 -## 🏡 Subject 3 +## 🏡 주제
4 현대인에게 있어 집 주변의 편의시설, 학군, 여가시설, 음식점 등은 매우 중요하다. 하지만 집을 알아볼 때 각 주소지별로 직접 일일이 검색하며 알아봐야 하는 불편함이 있다. 4 현대인에게 있어 집 주변의 편의시설, 학군, 여가시설, 음식점 등은 매우 중요하다. 하지만 집을 알아볼 때 각 주소지별로 직접 일일이 검색하며 알아봐야 하는 불편함이 있다.
5 따라서 본 프로젝트에서는 사용자가 자신이 알아보고자 하는 주소를 입력하면 그 **주소에 기반하여 각 카테고리(교통, 학군, 여가시설 등)에서의 점수**를 알려준다. 5 따라서 본 프로젝트에서는 사용자가 자신이 알아보고자 하는 주소를 입력하면 그 **주소에 기반하여 각 카테고리(교통, 학군, 여가시설 등)에서의 점수**를 알려준다.
6 6
7 -## 👫 Member 7 +## 👫 조원
8 * 컴퓨터공학과 안지영(2017110274) 8 * 컴퓨터공학과 안지영(2017110274)
9 * 컴퓨터공학과 이학주(2017104018) 9 * 컴퓨터공학과 이학주(2017104018)
10 * 컴퓨터공학과 정수연(2017104025) 10 * 컴퓨터공학과 정수연(2017104025)
11 11
12 -## 📋 Manual 12 +## 📋 사용방법
13 +http://www.abouturvillage.tk:3000/ 접속하여 사용해보실 수 있습니다!
13 **1. 주소지 입력** 14 **1. 주소지 입력**
14 ![검색 페이지](./public/img/demo_index.png) 15 ![검색 페이지](./public/img/demo_index.png)
15 **2. 알고싶은 카테고리를 선택하여 검사** 16 **2. 알고싶은 카테고리를 선택하여 검사**
...@@ -19,11 +20,11 @@ ...@@ -19,11 +20,11 @@
19 해당 카테고리에 대한 `평가등급`을 보여준다. 20 해당 카테고리에 대한 `평가등급`을 보여준다.
20 ![카테고리 선택](public/img/demo_result.png) 21 ![카테고리 선택](public/img/demo_result.png)
21 22
22 -## 🖥 Development 23 +## 🖥 개발환경
23 -- Frontend : EJS 24 +- Frontend : EJS template engine
24 -- Backend : Express 25 +- Backend : Express framework
25 26
26 -## 📑 API List 27 +## 📑 API 목록
27 - Kakao Maps API 28 - Kakao Maps API
28 - 경기도 내 전철역 통계 29 - 경기도 내 전철역 통계
29 - 경기도 내 맛집 현황 30 - 경기도 내 맛집 현황
...@@ -38,7 +39,7 @@ ...@@ -38,7 +39,7 @@
38 - 경기도 내 공공체육시설 현황 39 - 경기도 내 공공체육시설 현황
39 - CCTV 현황 40 - CCTV 현황
40 41
41 -## 🔌 Build 42 +## 🔌 실행방법
42 > **1. repository clone 하기** 43 > **1. repository clone 하기**
43 ```bash 44 ```bash
44 $ git clone http://khuhub.khu.ac.kr/zuzitsu/UR_Village.git 45 $ git clone http://khuhub.khu.ac.kr/zuzitsu/UR_Village.git
...@@ -51,7 +52,8 @@ $ cd UR_Village ...@@ -51,7 +52,8 @@ $ cd UR_Village
51 >> 1. /UR_VIllage 위치에서 `.env 파일`을 추가 52 >> 1. /UR_VIllage 위치에서 `.env 파일`을 추가
52 >> 2. .env 파일에서 발급받은 Kakao maps, 경기데이터드림, ODsay api key 추가 53 >> 2. .env 파일에서 발급받은 Kakao maps, 경기데이터드림, ODsay api key 추가
53 >> [경기데이터드림](https://data.gg.go.kr/portal/intro/develop/searchBulletinPage.do), 54 >> [경기데이터드림](https://data.gg.go.kr/portal/intro/develop/searchBulletinPage.do),
54 ->> [Kakao developers](https://developers.kakao.com/) 55 +>> [Kakao developers](https://developers.kakao.com/),
56 +>> [ODsay](https://lab.odsay.com/)
55 57
56 ``` 58 ```
57 KAKAO_APIKEY=[YOUR_API_KEY] 59 KAKAO_APIKEY=[YOUR_API_KEY]
......