|
1 |
| -## react-redux-bitcoin |
| 1 | +# React Bitcoin Monitor |
| 2 | + |
| 3 | +An app that monitors changes in the _Bitcoin Price Index (BPI)_. |
| 4 | + |
| 5 | +The BPI will be shown for the _USD_ currency. |
| 6 | + |
| 7 | +_Bitcoin Monitor_ makes use of the _[CoinDesk Bitcoin Price Index API]_. Go [here](https://www.coindesk.com/price/) for more price information by CoinDesk. |
| 8 | + |
| 9 | +Features: |
| 10 | + |
| 11 | +* Show Current BPI for USD currency |
| 12 | +* Show BPI for the past seven days for USD currency |
| 13 | + |
| 14 | +This project also demonstrates: |
| 15 | + |
| 16 | +* a typcial React project layout structure |
| 17 | +* babel setup and configuration |
| 18 | +* webpack setup and configuration |
| 19 | +* eslint setup and configuration |
| 20 | +* SCSS setup and configuration |
| 21 | +* [CoinDesk Bitcoin Price Index API] integration |
| 22 | +* Redux state management |
| 23 | +* Redux promise middleware |
| 24 | + |
| 25 | +**Screenshots:** |
| 26 | + |
| 27 | + |
| 28 | + |
| 29 | +--- |
| 30 | + |
| 31 | +## Developed With |
| 32 | + |
| 33 | +* [Node.js](https://nodejs.org/en/) - Javascript runtime |
| 34 | +* [React](https://reactjs.org/) - A javascript library for building user interfaces |
| 35 | +* [Redux](https://redux.js.org/) - A predictable state management implementation |
| 36 | +* [Redux-Promise-Middleware](https://github.com/pburtchaell/redux-promise-middleware) - FSA compliant Redux middleware for promises, async functions and conditional optimistic updates |
| 37 | +* [Babel](https://babeljs.io/) - A transpiler for javascript |
| 38 | +* [Webpack](https://webpack.js.org/) - A module bundler |
| 39 | +* [SCSS](http://sass-lang.com/) - A css metalanguage |
| 40 | +* [Bootstrap 4](https://getbootstrap.com/) - Bootstrap is an open source toolkit for developing with HTML, CSS, and JS |
| 41 | +* [Axios](https://github.com/axios/axios) - Promise based HTTP client for the browser and node.js |
| 42 | +* [CoinDesk Bitcoin Price Index API] - Provides Bitcoin Price Index data |
| 43 | + |
| 44 | +--- |
| 45 | + |
| 46 | +## Getting Started |
| 47 | + |
| 48 | +These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. |
| 49 | + |
| 50 | +### Prerequisites |
| 51 | + |
| 52 | +The following software is required to be installed on your system: |
| 53 | + |
| 54 | +* Node 8.x |
| 55 | +* Npm 3.x |
| 56 | + |
| 57 | +Type the following commands in the terminal to verify your node and npm versions |
| 58 | + |
| 59 | +```bash |
| 60 | +node -v |
| 61 | +npm -v |
| 62 | +``` |
| 63 | + |
| 64 | +### Install |
| 65 | + |
| 66 | +Follow the following steps to get development environment running. |
| 67 | + |
| 68 | +* Clone _'react-bitcoin-monitor'_ repository from GitHub |
| 69 | + |
| 70 | + ```bash |
| 71 | + git clone [email protected]:andyfrith/react-bitcoin-monitor.git |
| 72 | + ``` |
| 73 | + |
| 74 | +* Install node modules |
| 75 | + |
| 76 | + ```bash |
| 77 | + cd react-bitcoin-monitor |
| 78 | + yarn install |
| 79 | + ``` |
| 80 | + |
| 81 | +### Run |
| 82 | + |
| 83 | +* Run start |
| 84 | + |
| 85 | + ```bash |
| 86 | + yarn start |
| 87 | + ``` |
| 88 | + |
| 89 | +--- |
| 90 | + |
| 91 | +## Author |
| 92 | + |
| 93 | +* **Andy Frith** - _Initial work_ - [andyfrith](https://github.com/andyfrith) |
| 94 | + |
| 95 | +[coindesk bitcoin price index api]: https://www.coindesk.com/api/ |
0 commit comments