박정민

Update README.md with Image

Showing 1 changed file with 29 additions and 14 deletions
1 # **지자체별 행사 / 축제 정보 및 날씨 제공 서비스** 1 # **지자체별 행사 / 축제 정보 및 날씨 제공 서비스**
2 2
3 -이미지 통으로 올리고 링크걸어서 이미지 표시해주기 3 +<img src="/uploads/f0d26785b5a120c08f65a84506831889/TFTlogo.png" width="700" height="500">
4 +
4 5
5 ## 순서 6 ## 순서
6 * About the Project 7 * About the Project
...@@ -63,11 +64,6 @@ Built With ...@@ -63,11 +64,6 @@ Built With
63 git clone http://khuhub.khu.ac.kr/2018102190/TFT.git 64 git clone http://khuhub.khu.ac.kr/2018102190/TFT.git
64 ``` 65 ```
65 66
66 -* 폴더를 연 후 `npm install` 명령으로 npm 패키지 설치
67 - ```
68 - npm install
69 - ```
70 -
71 * apiHandler 부분의 server.js 파일에 발급받은 API를 입력해서 사용을 위한 준비를 완료한다 67 * apiHandler 부분의 server.js 파일에 발급받은 API를 입력해서 사용을 위한 준비를 완료한다
72 68
73 ## **프로젝트 구조 / 동작 방식** 69 ## **프로젝트 구조 / 동작 방식**
...@@ -87,17 +83,35 @@ Built With ...@@ -87,17 +83,35 @@ Built With
87 83
88 ## **Usage** 84 ## **Usage**
89 85
90 -+ 사진, 실제 구동 예시, 구동 방법 등 설명 필요 86 +1. Docker를 사용하는 경우
87 + 1. `docker-compose.yml` file이 있는 폴더에서 terminal을 연다
88 + 1. `docker-compose up -d` 명령을 실행한다
89 + 1. 서버를 종료할 때에는 `docker-compose down` 명령을 실행한다
90 +
91 +1. Docker를 사용하지 않는 경우
92 + 1. MongoDB가 정상적으로 작동되는지 확인한다
93 + 1. TFT_API, TFT_WEB 각 폴더에서 `npm install` 명령을 실행한다
94 + 1. 각 폴더에서 `npm start` 명령을 실행한다
95 +
96 +Service Overview
97 +
98 +
99 +![serviceOverview](/uploads/06baa0ebea9fd11478b3c6c9595dc2ad/serviceOverview.PNG)
100 +
101 +Select District
102 +
103 +
104 +![districtSelect](/uploads/1f2ea26d4cdfbb08428f7fba611f52f6/districtSelect.PNG)
105 +
106 +Show Festival List
107 +
91 108
92 -빌드 설치 설정 예시 / 방법 109 +![festivalList](/uploads/3304cdb999299785d14d71760088d569/festivalList.PNG)
93 110
94 -1. Docker에서 사용하는 경우 111 +Show total example
95 - Linux Command Line Interface를 이용하여 설치 필요
96 112
97 - docker 설치 필요하고, docker에서 mongodb를 띄워주야 하고,
98 113
99 -1. Docker에서 사용하지 않는 경우 114 +![showExample](/uploads/e5161983c8dba7027dd2e37d30d8a964/showExample.PNG)
100 - 1.
101 115
102 ## **Roadmap** 116 ## **Roadmap**
103 117
...@@ -115,7 +129,8 @@ Built With ...@@ -115,7 +129,8 @@ Built With
115 - [v] Frontend와 Backend Merge 실행 129 - [v] Frontend와 Backend Merge 실행
116 - [v] ApiHandler 간소화 (불필요한 파일 제거) 130 - [v] ApiHandler 간소화 (불필요한 파일 제거)
117 - [v] ApiHandler와 server.js merge 실행 131 - [v] ApiHandler와 server.js merge 실행
118 -- [v] 실행 예시 이미지 업로드 132 +- [v] Docker 활용하여 서비스 실행 구축
133 +- [v] Amazon AWS에 프로젝트 업로드 및 실행 예시 이미지 업로드
119 134
120 135
121 ## **Contribution** 136 ## **Contribution**
......