zuzitsu / UR_Village

Go to a project
Toggle navigation Toggle navigation pinning
Suyeon Jung
e4fcd354 1 parent d9e603e6

Update README

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