Skip to content

NadavsSchwartz/cryptoApp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

74 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Netlify Status Heroku

CryptoApp

One stop app for anything Cryptocurrency.

https://cryptoapp.win

Table of Contents


Description

CrypoApp was created to help people conveniently check crypto-related news, coin historical data, Exchange Data, etc.

Key Features

  • Free forever.
  • Integration of three API's (Coinranking, Coincap, Microsoft Bing news).
  • In depth graph details of price history for any coin, along with important data.
  • Dedicated news section with coin subject filters.
  • Dedicated exchanges table for quick stats on dozens of coins.
  • Query caching with Rails cache

Stack:

  • React (UI library)
  • Redux Toolkit (State management)
  • Antd (CSS styling solution library)
  • React Charts (Chart library)
  • Rails (Web app framework)

Back End REPO

CryptoApp Back end

Setup

To use CryptoApp locally, You need to have Node.js installed along with all the dependencies.

  1. Clone this and CryptoApp Back end repository
  2. Create an .env file in the back-end folder and fill it properly (see below).
  3. Install dependencies: npm install or yarn if you're using yarn.
  4. Run for development: npm run dev or yarn dev if you're using yarn.

Configuration

For the configuration, the following settings have to be added in your .env-file:

Please have ruby and rails installed prior to running the back end, as well as the other dependencies from the Back End repo.

Resources

HomePage

route method description Docs
'/' GET App's homepage. renders simplified version of each components code

CoinDetails

route methods description Docs
'/crypto/:coinId' GET renders show page for particular coin code

AllCoins

route methods description Docs
'/cryptocurrencies' GET shows all crypto currencies code

News

route Methods description Docs
'/news' GET renders crypto currency related news code

Exchanges

route Methods description Docs
'/exchanges' GET renders crypto currency exchanges table code

Contributing

Pull requests are welcome. You'll probably find lots of improvements to be made.

Open issues for feedback, requesting features, reporting bugs, or discuss ideas.

License

The app is available as open source under the terms of the MIT License.