Showing
1 changed file
with
95 additions
and
11 deletions
1 | -## 2021 - 2학기 오픈소스SW개발 프로젝트 | 1 | +# 2021 - 2학기 오픈소스SW개발 프로젝트 |
2 | 2 | ||
3 | -#### 지자체별 행사 / 축제 정보 및 날씨 제공 서비스 | 3 | +## 지자체별 행사 / 축제 정보 및 날씨 제공 서비스 |
4 | 4 | ||
5 | ---- | 5 | +* 지자체에서 개최하는 행사 정보와 날씨 데이터를 조합하고, 사용자에게 친숙한 인터페이스를 활용하여 지역/행사별로 날씨 정보를 한눈에 볼 수 있는 서비스를 제공한다. |
6 | -*** | ||
7 | ---- | ||
8 | 6 | ||
9 | -1. Service 1 - web | 7 | +Built With |
8 | + | ||
9 | +- Frontend | ||
10 | + * [Svelte](https://svelte.dev/) | ||
11 | +- Backend & DB | ||
12 | + * [Node.js](https://nodejs.org/ko/download/) | ||
13 | + * [MongoDB](https://www.mongodb.com/) | ||
14 | + | ||
15 | +## Getting Started | ||
16 | + | ||
17 | +### Prerequisites 사전 설치 파일 | ||
18 | + | ||
19 | +1. Docker를 사용하는 경우 (**권장**) | ||
20 | + * [도커 공식 홈페이지](https://www.docker.com/)에 접속하여 docker 및 docker-compose 설치 | ||
21 | +1. Docker를 사용하지 않는 경우 | ||
22 | + * [Node.js 공식 홈페이지](https://nodejs.org/ko/download/)에 접속하여 Node.js 설치 | ||
23 | + * [MongoDB 공식 홈페이지](https://www.mongodb.com/)에 접속하여 MongoDB 설치 | ||
24 | + * [Mongoexport 사용을 위한 tool](https://www.mongodb.com/try/download/database-tools?tck=docs_databasetools)에 접속하여 mongoexport 추가 가능 설치 | ||
25 | + * `Program files/mongodb/bin` 경로 안에 설치된 파일들 추가하여 확장 기능을 위한 설치 완료 | ||
26 | + | ||
27 | + | ||
28 | +### Installation 설치 | ||
29 | + | ||
30 | +* Windows의 경우 설치하고자 하는 폴더에 들어가서 우클릭한 후 `git bash` 를 클릭하여 터미널 창을 연다. | ||
31 | + | ||
32 | +* MacOs의 경우 터미널창을 연 후 Command Line Interface를 통하여 설치하고자 하는 폴더로 이동한다 | ||
33 | + | ||
34 | +* `git clone` 명령으로 프로젝트 폴더 clone | ||
35 | + ``` | ||
36 | + git clone http://khuhub.khu.ac.kr/2018102190/TFT.git | ||
37 | + ``` | ||
38 | + | ||
39 | +* `npm install` 명령으로 npm 패키지 설치 | ||
40 | + ``` | ||
41 | + npm install | ||
42 | + ``` | ||
43 | + | ||
44 | + | ||
45 | +## 프로젝트 구조 | ||
46 | + | ||
47 | +1. Service 1 - Web | ||
48 | + 1. Frontend | ||
49 | + 1. Svelte를 사용하여 관광지 정보 / 날씨 정보를 한눈에 볼 수 있게 알려주는 유저 인터페이스로 사용 | ||
50 | + 1. [카카오 지도 API](https://apis.map.kakao.com/)를 호출하여 지도 위에 핀 및 마커 설정 | ||
10 | 1. Backend Server | 51 | 1. Backend Server |
11 | 1. MongoDB Atlas와 서버를 연동하여 Database와 Node.js 연결 | 52 | 1. MongoDB Atlas와 서버를 연동하여 Database와 Node.js 연결 |
12 | 1. DB에서 json 형태의 데이터를 불러 온 후 Frontend에서 유저에 의한 요청 발생 시 Frontend로 전송 | 53 | 1. DB에서 json 형태의 데이터를 불러 온 후 Frontend에서 유저에 의한 요청 발생 시 Frontend로 전송 |
13 | - 1. Frontend | ||
14 | - 1. Svelte를 사용하여 관광지 정보 / 날씨 정보를 알려주는 유저 인터페이스로 사용 | ||
15 | - | ||
16 | 1. Service 2 - DB | 54 | 1. Service 2 - DB |
17 | 1. API로부터 받아온 정보를 관리하고 MongoDB Atlas를 활용하여 Server에 제공 | 55 | 1. API로부터 받아온 정보를 관리하고 MongoDB Atlas를 활용하여 Server에 제공 |
18 | - | ||
19 | 1. Service 3 - API Handler | 56 | 1. Service 3 - API Handler |
20 | 1. [관광공사 API](https://api.visitkorea.or.kr/main.do)를 호출하여 Database에 Write함 | 57 | 1. [관광공사 API](https://api.visitkorea.or.kr/main.do)를 호출하여 Database에 Write함 |
21 | - 1. [카카오 지도 API](https://apis.map.kakao.com/)를 호출하여 지도 위에 핀 및 마커 설정 | 58 | + 1. [기상청 API](https://data.kma.go.kr/api/selectApiList.do?pgmNo=42)를 호출하여 날씨 및 기상 관련 정보 가져옴 |
59 | + | ||
60 | +## Usage 사용법 | ||
61 | + | ||
62 | +빌드 설치 설정 예시 / 방법 | ||
63 | + | ||
64 | +1. Docker에서 사용하는 경우 | ||
65 | + 1. Docker-compose를 이용하여 | ||
66 | +1. 직접 소스코드를 수정하는 경우 | ||
67 | + | ||
68 | + | ||
69 | +## Roadmap | ||
70 | + | ||
71 | +* 무슨 기능들 구현했는지 시간에 따라 | ||
72 | + | ||
73 | + | ||
74 | +- [v] 처음 구현한 기능 | ||
75 | +- [v] 그다음 구현한 기능 | ||
76 | +- [v] 세번째 구현한 기능 | ||
77 | +- [ ] 네번째 구현한 기능 | ||
78 | +- [ ] 다섯번째 구현한 기능 | ||
79 | + - [ ] 세부기능1 | ||
80 | + - [ ] 세부기능2 | ||
81 | + | ||
82 | +## Contribution | ||
83 | + | ||
84 | +프로젝트에 대한 어떠한 참여나 추가 개발도 **환영합니다**. | ||
85 | + | ||
86 | +만약 프로젝트 발전을 위한 더 좋은 방법이 있으시다면 저희의 repo를 fork하신 후 pull request를 부탁드립니다. | ||
87 | + | ||
88 | +1. 프로젝트 fork 해오기 (` git clone http://khuhub.khu.ac.kr/2018102190/TFT.git `) | ||
89 | +2. 새로운 기능을 위한 branch 생성 (` git checkout -b feature/newFeature `) | ||
90 | +3. 바뀐 파일들 commit하기 (` git commit -m 'Add some newFeature' ` ) | ||
91 | +4. Fork된 Branch에 바뀐 파일들 push하기 (` git push origin feature/newFeature `) | ||
92 | +5. Pull Request 보내기 | ||
93 | + | ||
94 | +## License | ||
95 | + | ||
96 | + | ||
97 | + | ||
98 | +## Contact | ||
99 | + | ||
100 | +2018102198 서준혁 junhyuk0801@khu.ac.kr | ||
101 | + | ||
102 | +2018102194 배형석 qogudtjr7@khu.ac.kr | ||
103 | + | ||
104 | +2018102190 박정민 jungmin59@khu.ac.kr | ||
22 | 105 | ||
106 | +프로젝트 주소 : [http://khuhub.khu.ac.kr/2018102190/TFT.git](http://khuhub.khu.ac.kr/2018102190/TFT.git) | ... | ... |
-
Please register or login to post a comment