Showing
1 changed file
with
216 additions
and
0 deletions
README.md
0 → 100644
| 1 | +<!-- | ||
| 2 | +*** Thanks for checking out the Best-README-Template. If you have a suggestion | ||
| 3 | +*** that would make this better, please fork the repo and create a pull request | ||
| 4 | +*** or simply open an issue with the tag "enhancement". | ||
| 5 | +*** Thanks again! Now go create something AMAZING! :D | ||
| 6 | +--> | ||
| 7 | + | ||
| 8 | + | ||
| 9 | + | ||
| 10 | +<!-- PROJECT SHIELDS --> | ||
| 11 | +<!-- | ||
| 12 | +*** I'm using markdown "reference style" links for readability. | ||
| 13 | +*** Reference links are enclosed in brackets [ ] instead of parentheses ( ). | ||
| 14 | +*** See the bottom of this document for the declaration of the reference variables | ||
| 15 | +*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use. | ||
| 16 | +*** https://www.markdownguide.org/basic-syntax/#reference-style-links | ||
| 17 | +--> | ||
| 18 | +<!-- [![Contributors][contributors-shield]][contributors-url] | ||
| 19 | +[![Forks][forks-shield]][forks-url] | ||
| 20 | +[![Stargazers][stars-shield]][stars-url] | ||
| 21 | +[![Issues][issues-shield]][issues-url] | ||
| 22 | +[![MIT License][license-shield]][license-url] | ||
| 23 | +[![LinkedIn][linkedin-shield]][linkedin-url] --> | ||
| 24 | + | ||
| 25 | + | ||
| 26 | + | ||
| 27 | +<!-- PROJECT LOGO --> | ||
| 28 | +<br /> | ||
| 29 | +<p align="center"> | ||
| 30 | + <!-- <a href="https://github.com/othneildrew/Best-README-Template"> | ||
| 31 | + <img src="images/logo.png" alt="Logo" width="80" height="80"> | ||
| 32 | + </a> --> | ||
| 33 | + | ||
| 34 | + <h1 align="center">Coin-trade-assistant</h1> | ||
| 35 | + | ||
| 36 | + <!-- <p align="center"> | ||
| 37 | + An awesome README template to jumpstart your projects! | ||
| 38 | + <br /> | ||
| 39 | + <a href="https://github.com/othneildrew/Best-README-Template"><strong>Explore the docs »</strong></a> | ||
| 40 | + <br /> | ||
| 41 | + <br /> | ||
| 42 | + <a href="https://github.com/othneildrew/Best-README-Template">View Demo</a> | ||
| 43 | + · | ||
| 44 | + <a href="https://github.com/othneildrew/Best-README-Template/issues">Report Bug</a> | ||
| 45 | + · | ||
| 46 | + <a href="https://github.com/othneildrew/Best-README-Template/issues">Request Feature</a> | ||
| 47 | + </p> --> | ||
| 48 | +</p> | ||
| 49 | + | ||
| 50 | + | ||
| 51 | + | ||
| 52 | +<!-- TABLE OF CONTENTS --> | ||
| 53 | +## Table of Contents | ||
| 54 | +<details open="open"> | ||
| 55 | + <ol> | ||
| 56 | + <li> | ||
| 57 | + <a href="#about-the-project">About The Project</a> | ||
| 58 | + <ul> | ||
| 59 | + <li><a href="#built-with">Built With</a></li> | ||
| 60 | + </ul> | ||
| 61 | + </li> | ||
| 62 | + <li> | ||
| 63 | + <a href="#installation">Installation</a> | ||
| 64 | + </li> | ||
| 65 | + <li><a href="#usage">Usage</a></li> | ||
| 66 | + <li><a href="#contributing">Contributing</a></li> | ||
| 67 | + <li><a href="#license">License</a></li> | ||
| 68 | + <li><a href="#contact">Contact</a></li> | ||
| 69 | + </ol> | ||
| 70 | +</details> | ||
| 71 | + | ||
| 72 | + | ||
| 73 | + | ||
| 74 | +<!-- ABOUT THE PROJECT --> | ||
| 75 | +## About The Project | ||
| 76 | +<!-- [![Product Name Screen Shot][product-screenshot]](https://example.com) --> | ||
| 77 | + | ||
| 78 | +코인과 관련된 유용한 정보를 얻을 수 있다. | ||
| 79 | + | ||
| 80 | +* 국내와 해외의 코인 시세 차이 확인 | ||
| 81 | +* 최근 거래량이 활발한 코인 확인 | ||
| 82 | +* 고래들이 입금한 코인과 코인 액수 확인 | ||
| 83 | + | ||
| 84 | +### Built With | ||
| 85 | +<!-- | ||
| 86 | +This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples. --> | ||
| 87 | +* [NodeJS](https://nodejs.org/en/) | ||
| 88 | + | ||
| 89 | +<!-- GETTING STARTED --> | ||
| 90 | +<!-- ## Getting Started | ||
| 91 | + | ||
| 92 | +This is an example of how you may give instructions on setting up your project locally. | ||
| 93 | +To get a local copy up and running follow these simple example steps. --> | ||
| 94 | + | ||
| 95 | +<!-- ### Prerequisites | ||
| 96 | + | ||
| 97 | +This is an example of how to list things you need to use the software and how to install them. | ||
| 98 | +* npm | ||
| 99 | + ```sh | ||
| 100 | + npm install | ||
| 101 | + ``` --> | ||
| 102 | + | ||
| 103 | +## Installation | ||
| 104 | + | ||
| 105 | +1. Get a free API Key at | ||
| 106 | +[WhaleAlert 오픈 API](https://whale-alert.io/), | ||
| 107 | +[LINE CHANNEL iD](https://developers.line.biz/en/), | ||
| 108 | +[바이넌스 오픈 API](https://www.binance.com/ko/support/faq/c-6) | ||
| 109 | +2. Clone the repo | ||
| 110 | + ``` | ||
| 111 | + git clone http://khuhub.khu.ac.kr/2018102235/Coin-trade-assistant.git | ||
| 112 | + ``` | ||
| 113 | +3. Install NPM packages | ||
| 114 | + ``` | ||
| 115 | + npm install | ||
| 116 | + ``` | ||
| 117 | +4. Enter your API in `apikey.json` | ||
| 118 | + ``` | ||
| 119 | + { | ||
| 120 | + "line_token" : {Your API key}, | ||
| 121 | + "binance_key" : {Your API key} | ||
| 122 | + } | ||
| 123 | + ``` | ||
| 124 | + Enter your API in `apikeyWhale` | ||
| 125 | + ``` | ||
| 126 | + {Your API key} | ||
| 127 | + ``` | ||
| 128 | + | ||
| 129 | + | ||
| 130 | +<!-- USAGE EXAMPLES --> | ||
| 131 | +## Usage | ||
| 132 | +1. 국내 시세 차이 확인 | ||
| 133 | +BTC 시세차익 확인 | ||
| 134 | +``` | ||
| 135 | + 김프 {코인 심볼 ex) BTC, ETC, ...} | ||
| 136 | +``` | ||
| 137 | +2. 최근 활발한 거래량 확인 | ||
| 138 | +``` | ||
| 139 | + 거래량 비율 | ||
| 140 | +``` | ||
| 141 | +3. 고래들의 입금량 확인 | ||
| 142 | +고래들의 입금량을 실시간으로 알림받음 | ||
| 143 | +``` | ||
| 144 | + 고래알람 | ||
| 145 | +``` | ||
| 146 | + 알림 해제 | ||
| 147 | +``` | ||
| 148 | + 고래알람해제 | ||
| 149 | +``` | ||
| 150 | + | ||
| 151 | + | ||
| 152 | + | ||
| 153 | +<!-- CONTRIBUTING --> | ||
| 154 | +## Contributing | ||
| 155 | + | ||
| 156 | +Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. | ||
| 157 | + | ||
| 158 | +1. Fork the Project | ||
| 159 | +2. Create your Feature Branch (`git checkout -b {Feature Name}`) | ||
| 160 | +3. Commit your Changes (`git commit -m 'Add some {Feature Content}'`) | ||
| 161 | +4. Push to the Branch (`git push origin {Feature Name}`) | ||
| 162 | +5. Open a Pull Request | ||
| 163 | + | ||
| 164 | + | ||
| 165 | + | ||
| 166 | +<!-- LICENSE --> | ||
| 167 | +## License | ||
| 168 | + | ||
| 169 | +Distributed under the MIT License. See `LICENSE` for more information. | ||
| 170 | + | ||
| 171 | + | ||
| 172 | + | ||
| 173 | +<!-- CONTACT --> | ||
| 174 | +## Contact | ||
| 175 | + | ||
| 176 | +배지승(2018102193) - [@email](n1mb0606@khu.ac.kr) - n1mb0606@khu.ac.kr | ||
| 177 | +정홍주(2018000000) - [@email]() - | ||
| 178 | +전현진(2018000000) - [@email]() - | ||
| 179 | + | ||
| 180 | +Project Link: [http://khuhub.khu.ac.kr/2018102235/Coin-trade-assistant.git](http://khuhub.khu.ac.kr/2018102235/Coin-trade-assistant.git) | ||
| 181 | + | ||
| 182 | + | ||
| 183 | + | ||
| 184 | +<!-- ACKNOWLEDGEMENTS --> | ||
| 185 | +<!-- ## Acknowledgements | ||
| 186 | +* [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet) | ||
| 187 | +* [Img Shields](https://shields.io) | ||
| 188 | +* [Choose an Open Source License](https://choosealicense.com) | ||
| 189 | +* [GitHub Pages](https://pages.github.com) | ||
| 190 | +* [Animate.css](https://daneden.github.io/animate.css) | ||
| 191 | +* [Loaders.css](https://connoratherton.com/loaders) | ||
| 192 | +* [Slick Carousel](https://kenwheeler.github.io/slick) | ||
| 193 | +* [Smooth Scroll](https://github.com/cferdinandi/smooth-scroll) | ||
| 194 | +* [Sticky Kit](http://leafo.net/sticky-kit) | ||
| 195 | +* [JVectorMap](http://jvectormap.com) | ||
| 196 | +* [Font Awesome](https://fontawesome.com) --> | ||
| 197 | + | ||
| 198 | + | ||
| 199 | + | ||
| 200 | + | ||
| 201 | + | ||
| 202 | +<!-- MARKDOWN LINKS & IMAGES --> | ||
| 203 | +<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --> | ||
| 204 | +<!-- [contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge | ||
| 205 | +[contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors | ||
| 206 | +[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=for-the-badge | ||
| 207 | +[forks-url]: https://github.com/othneildrew/Best-README-Template/network/members | ||
| 208 | +[stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=for-the-badge | ||
| 209 | +[stars-url]: https://github.com/othneildrew/Best-README-Template/stargazers | ||
| 210 | +[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=for-the-badge | ||
| 211 | +[issues-url]: https://github.com/othneildrew/Best-README-Template/issues | ||
| 212 | +[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge | ||
| 213 | +[license-url]: https://github.com/othneildrew/Best-README-Template/blob/master/LICENSE.txt | ||
| 214 | +[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 | ||
| 215 | +[linkedin-url]: https://linkedin.com/in/othneildrew | ||
| 216 | +[product-screenshot]: images/screenshot.png --> | ||
| ... | \ No newline at end of file | ... | \ No newline at end of file |
-
Please register or login to post a comment