박지환

Update README.md

Showing 1 changed file with 55 additions and 25 deletions
1 +[<img src="https://img.shields.io/badge/Node.js-339933?style=for-the-badge&logo=Node.js&logoColor=white">](https://nodejs.org/ko/)
2 +[<img src="https://img.shields.io/badge/Express-000000?style=for-the-badge&logo=Express&logoColor=white">](https://expressjs.com/ko/)
3 +
4 +<div align="center"><img src="./image/title.PNG" width="70%" height="70%"></div>
5 +
6 +# 공휴일 카운터 및 활동 추천 (Holiday-Counter-Recommend-Activity)
7 +
8 +사용자에게 가장 가까운 공휴일의 남은 날짜와 추천하는 활동을 알려주는 웹/앱입니다.
9 +
1 ## About The Project 10 ## About The Project
2 11
3 ---- 12 +- Open Api로부터 이번달의 공휴일 정보를 불러옵니다.
13 +- 현재 날짜 이후로부터 가장 가까운 공휴일의 남은 날짜와 추천하는 활동을 알려줍니다.
4 14
5 -공휴일 카운터 및 활동 추천 15 +### Overview
6 16
7 -## Getting Started (Installation) 17 +Require overview image
8 18
9 ---- 19 +### Project Architecture
20 +
21 +Require project architecture image
22 +
23 +### Built With
24 +
25 +- [Node.js](https://nodejs.org/ko/)
26 +- [Express](https://expressjs.com/ko/)
27 +
28 +## Getting Started
10 29
11 ### Prerequisites 30 ### Prerequisites
12 31
13 -- Node.js 32 +Need to get your service key from **[here](https://www.data.go.kr/data/15012690/openapi.do)**
33 +- `holiday-counter-recommend-activity/nodejs/.env`
34 +
35 +```dotenv
36 +API_KEY=INPUT_YOUR_SERVICE_KEY
37 +```
14 38
15 ### Installation 39 ### Installation
16 40
17 -1. Clone the repository 41 +1. Clone the repository
18 -[copy content="git clone http://khuhub.khu.ac.kr/teamPARK/holiday-counter-recommend-activity.git"] 42 +```shell
19 -2. Install NPM packages 43 +git clone http://khuhub.khu.ac.kr/teamPARK/holiday-counter-recommend-activity.git
20 -[copy content="npm install"] 44 +```
21 -3. Open Server
22 -[copy content="npm start"]
23 45
24 -## Built with 46 +2. Write your service key that you get in prerequisite to
25 -- [Node.js](https://nodejs.org/ko/) 47 +```shell
48 +holiday-counter-recommend-activity/nodejs/.env
49 + ```
26 50
51 +3. Install NPM packages
52 +```shell
53 +npm install
54 +```
27 55
28 -## Contributing 56 +4. Open Server
57 +```shell
58 +npm start
59 +```
29 60
30 ---- 61 +## Contributing
31 62
32 -다음 과정을 통해 프로젝트에 기여할 수 있습니다. 63 +다음 과정을 통해 프로젝트에 기여할 수 있습니다.
33 64
34 1. Fork the project repository 65 1. Fork the project repository
35 -2. Create your branch 66 +2. Create your branch (git checkout feature/name)
36 -3. Make changes and commit 67 +3. Make changes and commit (git commit -m "Input your commit contents")
37 -4. Push to your own Gibhub repository 68 +4. Push to your own Gibhub repository (git push origin feature/name)
38 5. Create a pull request 69 5. Create a pull request
39 70
40 -. 71 +## Contact
41 72
73 +- 박지환: peto@khu.ac.kr
74 +- 박규리: kyuri0924@khu.ac.kr
75 +- 박종현: asd401200@khu.ac.kr
42 76
43 -## Contact 77 + **[Project Link](http://khuhub.khu.ac.kr/teamPARK/holiday-counter-recommend-activity.git)**
44 -박지환
45 -박규리
46 -박종현
47 -[프로젝트 링크] (http://khuhub.khu.ac.kr/teamPARK/holiday-counter-recommand-activity.git)
...\ No newline at end of file ...\ No newline at end of file
......