지자체별 행사 / 축제 정보 및 날씨 제공 서비스

순서

About the Project
Getting Started
- Prerequisites
- Installation
프로젝트 구조 / 동작 방식
Usage
Roadmap
Contribution
License
Contact

About the Project

기존에 축제나 행사를 검색하기 위해서는 행사가 언제 어디서 열리는지 파악하고, 그 날짜에 맞춰서 날씨를 또 검색해 보아야 하는 번거로움이 있었다. 이러한 일련의 번거로운 과정들을 한 데 묶어 몇 번의 클릭으로 사용자가 원하는 행사 및 축제 정보를 디스플레이 함으로써 사용자의 편의 증대라는 효과를 가져올 수 있을 것으로 예상된다.

본 서비스는 지자체에서 개최하는 행사 정보와 날씨 데이터를 API를 통하여 받아온 후 그를 조합하여 사용자에게 친숙한 인터페이스(svelte 활용)를 통해 지역 / 행사별로 날씨 정보를 한눈에 볼 수 있는 서비스를 제공한다.

Built With

WEB
- Node.js
- Svelte
- Express
Database
- MongoDB
API Handler

Getting Started

Prerequisites

Docker를 사용하는 경우 (권장)
- 도커 공식 홈페이지에 접속하여 docker 및 docker-compose 설치
Docker를 사용하지 않는 경우
- Node.js 공식 홈페이지에 접속하여 Node.js 설치
- MongoDB 공식 홈페이지에 접속하여 MongoDB 설치
- Mongoexport 사용을 위한 tool에 접속하여 mongoexport 추가 기능 설치
- Program files/mongodb/bin 경로 안에 설치된 파일들 추가하여 확장 기능을 위한 설치 완료

Installation

Free API Key를 기상청 API, 관광공사 API, 카카오 지도 API 공식 사이트에서 받아온다
Windows의 경우 설치하고자 하는 폴더에 들어가서 우클릭한 후 git bash 를 클릭하여 터미널 창을 연다
MacOs의 경우 터미널창을 연 후 Command Line Interface를 통하여 설치하고자 하는 폴더로 이동한다

git clone 명령으로 프로젝트 폴더 clone

git clone http://khuhub.khu.ac.kr/2018102190/TFT.git

ServiceKey 폴더 안의 text 파일에 발급받은 API 키를 입력한다

프로젝트 구조 / 동작 방식

Service 1 - Web
1. Frontend
  1. Svelte를 사용하여 관광지 정보 / 날씨 정보를 한눈에 볼 수 있게 알려주는 유저 인터페이스로 사용
  2. 카카오 지도 API를 호출하여 지도 위에 핀 및 마커 설정
2. Backend Server
  1. MongoDB Atlas와 서버를 연동하여 Database와 Node.js 연결
  2. DB에서 json 형태의 데이터를 불러 온 후 Frontend에서 유저에 의한 요청 발생 시 Frontend로 전송
Service 2 - DB
1. API로부터 받아온 정보를 관리하고 MongoDB Atlas를 활용하여 Server에 제공
Service 3 - API Handler
1. 관광공사 API를 호출하여 Database에 Write함
2. 기상청 API를 호출하여 날씨 및 기상 관련 정보 가져옴

Usage

Docker를 사용하는 경우
1. docker-compose.yml file이 있는 폴더에서 terminal을 연다
2. docker-compose up -d 명령을 실행한다
3. 서버를 종료할 때에는 docker-compose down 명령을 실행한다
Docker를 사용하지 않는 경우
1. MongoDB가 정상적으로 작동되는지 확인한다
2. TFT_API, TFT_WEB 각 폴더에서 npm install 명령을 실행한다
3. 각 폴더에서 npm start 명령을 실행한다