이의준
1 +The MIT License (MIT)
2 +
3 +Copyright (c) 2021 홍용민
4 +
5 +Permission is hereby granted, free of charge, to any person obtaining a copy
6 +of this software and associated documentation files (the "Software"), to deal
7 +in the Software without restriction, including without limitation the rights
8 +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 +copies of the Software, and to permit persons to whom the Software is
10 +furnished to do so, subject to the following conditions:
11 +
12 +The above copyright notice and this permission notice shall be included in all
13 +copies or substantial portions of the Software.
14 +
15 +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 +SOFTWARE.
...@@ -6,16 +6,52 @@ ...@@ -6,16 +6,52 @@
6 > + 국제캠퍼스의 학생 누구나 간편하게 사용가능합니다. 6 > + 국제캠퍼스의 학생 누구나 간편하게 사용가능합니다.
7 7
8 ## Getting Started 8 ## Getting Started
9 -> http://2020105677.oss2021.tk:23023로 접속하면 바로 버스정보를 조회할 수 있습니다! 9 +### installation
10 +> + 전체 코드는 http://khuhub.khu.ac.kr/2020105677/BusTime.git 에 존재합니다.
11 +> + 직접 코드를 실행하실 분들은 아래의 과정을 따라하세요.
12 +
13 +1. https://www.gbis.go.kr/gbis2014/publicService.action?cmd=publickKey 에서 경기버스정보 api key를 발급받습니다.
14 +2. repository를 clone 합니다
15 + ```
16 + git clone http://khuhub.khu.ac.kr/2020105677/BusTime.git
17 + ```
18 +3. 패키지를 다운로드 받습니다
19 + ```
20 + npm install
21 + ```
22 +4. .env파일을 만들어 발급받은 키를 입력합니다
23 + ```
24 + key = 'enter your key'
25 + ```
26 +5. .env파일을 repository의 최상단 폴더에 저장합니다
10 27
11 ## Usage 28 ## Usage
29 +> http://2020105677.oss2021.tk:23023 로 접속하면 바로 버스정보를 조회할 수 있습니다!
12 > + 처음 접속하면 하단에 사색의 광장에서 출발하는 버스 4종류의 number가 있습니다. 30 > + 처음 접속하면 하단에 사색의 광장에서 출발하는 버스 4종류의 number가 있습니다.
13 > + 그중 하나를 클릭하면 사용자가 조회한 시간을 기준으로 버스의 출발 예정시간과 남은시간을 제공해줍니다. 31 > + 그중 하나를 클릭하면 사용자가 조회한 시간을 기준으로 버스의 출발 예정시간과 남은시간을 제공해줍니다.
14 32
15 -## Prerequisite 33 +## Contributing
16 -> + 전체 코드는 http://khuhub.khu.ac.kr/2020105677/BusTime.git에 존재합니다. 34 +> + 추가 혹은 수정하고 싶은 기능이 있을 경우 아래의 과정을 따라주세요
17 -> + 직접 코드를 실행하실 분들은 아래의 과정을 따라하세요. 35 +
18 -> + git clone http://khuhub.khu.ac.kr/2020105677/BusTime.git 36 +1. project를 fork합니다
19 -> + npm install 37 +2. feature branch를 생성합니다.
38 + ```
39 + git checkout -b newFeature
40 + ```
41 +3. 변경사항을 commit 합니다
42 + ```
43 + git commit -m "add/modify some feature"
44 + ```
45 +4. branch에 push 합니다
46 + ```
47 + git push origin newFeature
48 + ```
49 +5. pull request를 보냅니다
50 +
51 +## License
52 +> + MIT라이센스에 따라 배포되었습니다. 더 많은 정보는 다음(https://choosealicense.com/licenses/mit/) 을 참고해주세요.
20 53
21 -## Contact
...\ No newline at end of file ...\ No newline at end of file
54 +## Contact
55 +> + 유영빈 youngbin0313@khu.ac.kr
56 +> + 이의준 choah76@khu.ac.kr
57 +> + 홍용민 mougue3292@khu.ac.kr
...\ No newline at end of file ...\ No newline at end of file
......