CryptoData

An awesome crypto dashboard to look for crypto data
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

There are many crypto dashboards out there, but I wanted to build one of my own with actual functionality so this is the result. It can look for top cryptos, specific ones and show information about them. Also it has a news tab with some news about crypto brought by bing.

(back to top)

Built With

This section should list any major frameworks/libraries used to build this project.

• React.js
• Redux
• Ant.Design
• Moment.js
• Chart.js

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

First of all you need the package manager NPM, to install it use the command below:

• npm

  npm install npm@latest -g

Installation

1. Get a free API Key at https://rapidapi.com for CoinRanking and Bing Search
2. Clone the repo

   git clone https://github.com/feliperucunha/crypto-data.git

3. Install NPM packages

   npm install

4. Enter your API in .env

   REACT_APP_RAPIDAPI_KEY = 'ENTER YOUR API'
   REACT_APP_CRYPTO_API_URL = 'ENTER YOUR API'
   REACT_APP_NEWS_API_URL = 'ENTER YOUR API'
   REACT_APP_NEWS_RAPIDAPI_HOST = 'ENTER YOUR API'
   REACT_APP_CRYPTO_RAPIDAPI_HOST = 'ENTER YOUR API'

(back to top)

Usage

The home page has some top information about coins and some news. This dashboard is pretty straight forward. You can access anything through the navbar and click on any card to see the specific details about a coin. You can also check the news on the news tab.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Author

_{Felipe Cunha}

(back to top)

Contact

(back to top)