맹주환

Update readme.md

Showing 1 changed file with 126 additions and 19 deletions
1 -# **Project OverView** 1 +<!--
2 +*** Thanks for checking out the Best-README-Template. If you have a suggestion
3 +*** that would make this better, please fork the repo and create a pull request
4 +*** or simply open an issue with the tag "enhancement".
5 +*** Thanks again! Now go create something AMAZING! :D
6 +-->
7 +<!-- PROJECT SHIELDS -->
8 +<!--
9 +*** I'm using markdown "reference style" links for readability.
10 +*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
11 +*** See the bottom of this document for the declaration of the reference variables
12 +*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
13 +*** https://www.markdownguide.org/basic-syntax/#reference-style-links
2 14
3 -## Take an Umbrella
4 15
5 -우산 챙기세요! : 날씨 API를 활용한 Philps Hue(조명) 제어 서비스 16 +<!-- TABLE OF CONTENTS -->
17 +<details open="open">
18 + <summary>Table of Contents</summary>
19 + <ol>
20 + <li>
21 + <a href="#about-the-project">About The Project</a>
22 + <ul>
23 + <li><a href="#built-with">Built With</a></li>
24 + </ul>
25 + </li>
26 + <li>
27 + <a href="#getting-started">Getting Started</a>
28 + </li>
29 + <li><a href="#usage">Usage</a></li>
30 + <li><a href="#roadmap">Roadmap</a></li>
31 + <li><a href="#contributing">Contributing</a></li>
32 + <li><a href="#license">License</a></li>
33 + <li><a href="#contact">Contact</a></li>
34 + <li><a href="#acknowledgements">Acknowledgements</a></li>
35 + </ol>
36 +</details>
6 37
7 -## **Using API** 38 +<!-- ABOUT THE PROJECT -->
8 -Google Maps API 39 +# About the Project
40 +이 프로젝트는 날씨 API를 통해 강수확률을 받아와 조명을 제어하는 프로젝트입니다.
9 41
10 -공공데이터포털 기상청 단기예보 조회서비스 API 42 +## Built With
43 +Node.js
11 44
12 -공공데이터포털 한국환경공단 에어코리아 대기오염정보 API 45 +## Using API
46 +공공데이터포털 기상청 단기예보 조회서비스 API (https://www.data.go.kr/index.do)
13 47
14 -NPM node-hue API 48 +Node-hue-API (https://github.com/peter-murray/node-hue-api)
15 49
16 -## **How it works** 50 +Google maps API (https://developers.google.com/)
17 51
18 -1. html5를 이용한 실시간 위치 정보 파악(google map API 사용) 52 +## Using Node Package
19 -2. 획득한 위치 정보를 바탕으로 강수확률 및 미세먼지 예보 받아오기(공공데이터포털 API 사용) 53 +Express
20 -3. 사용자 지정 시간대(ex.외출 전)에 조명 색으로 기상정보 알림(NPM Philps-Hue API 사용)
21 -4. 강수확률이 높을 수록 더욱 진한 파랑색 / 미세먼지 주의보 단계 높을 수록 짙은 황색 / 강수확률과 미세먼지 주의보 공존시 빨간색
22 -5. AWS를 통한 서비스 제공 계획
23 54
55 +Request
24 56
25 -<<<<<<< HEAD 57 +React
26 -경위도 : https://developers.google.com/maps/documentation/javascript/examples/map-geolocation?hl=ko#maps_map_geolocation-javascript 58 +
27 -======= 59 +http-proxy-middleware
28 -https://www.data.go.kr/tcs/dss/selectApiDataDetailView.do?publicDataPk=15084084 기상청 60 +
29 ->>>>>>> feature/add_Weather_API 61 +google-maps-react
62 +
63 +axios
64 +
65 +corp
66 +
67 +moment
68 +
69 +
70 +<!-- GETTING STARTED -->
71 +# Getting Started
72 +
73 +```
74 +$ npm install
75 +```
76 +
77 +<!-- USAGE -->
78 +```
79 +$ npm start
80 +```
81 +프로젝트는 Server와 Client 폴더로 나뉘며, Server에는 express, Client에는 react.js가 설치되어 있습니다.
82 +
83 +package.json에 이를 동시에 실행할 수 있도록 script를 작성한 상태입니다.
84 +
85 +이를 각각 실행하기 위해서는 프로젝트 폴더에서 아래와 같이 입력합니다.
86 +
87 +```
88 +$ npm run server
89 +```
90 +```
91 +$ npm run client
92 +```
93 +
94 +1. react.js의 main page 접속(기본 포트 : 3000)
95 +2. 웹 브라우저 상의 위치 정보 이용 동의
96 +3. React-axios POST를 통해 server로 위치 정보 값 전송
97 +4. Server내의 GET을 통해 전달된 위치 정보 및 현재 시간으로 기상 예보 조회
98 +5. 기상 예보 조회된 값을 바탕으로 node-hue-api로 조명 제어
99 +
100 +<!-- CONTRIBUTING -->
101 +# Contributing
102 +
103 +Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
104 +
105 +1. Fork the Project
106 +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
107 +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
108 +4. Push to the Branch (`git push origin feature/AmazingFeature`)
109 +5. Open a Pull Request
110 +
111 +
112 +
113 +<!-- LICENSE -->
114 +# License
115 +
116 +Distributed under the MIT License. See `LICENSE` for more information.
117 +
118 +
119 +
120 +<!-- CONTACT -->
121 +# Contact
122 +
123 +philosophist@khu.ac.kr
124 +
125 +Project Link: [http://khuhub.khu.ac.kr/2017101598/take_an_umbrella](http://khuhub.khu.ac.kr/2017101598/take_an_umbrella)
126 +
127 +
128 +
129 +<!-- ACKNOWLEDGEMENTS -->
130 +
131 +# Acknowledgements
132 +* [takeknowledge.log](https://velog.io/@takeknowledge)
133 +* [VELOPERT.LOG](https://velopert.com/)
134 +* [song.log](https://singa-korean.tistory.com/)
135 +* [Pluralsight](https://www.pluralsight.com/)
136 +* [baegofda_](https://baegofda.tistory.com/)
......