📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Crypto Metrics

Crypto Metrics is a mobile web application that uses CoinStats API to display the list of cryptocurrencies and their market capitalization. Built with React and Redux.

🛠 Built With

Tech Stack

Client

• React.js
• Redux

Key Features

• Home Page displays a list of all cryptcurrencies
• User can search any cryptocurrency from the list
• Detail of each currency is displayed by clicking on the card on home page

(back to top)

🚀 Live Demo

• Live Demo

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• node.js
• git

Setup

Clone this repository to your desired folder:

• Open your terminal

• Navigate to the directory where you want to clone the project.

• Clone the project using by running the following command:

git clone https://github.com/AbeeraTahir/react-capstone.git

Install

Install this project using the following command:

npm install

Usage

To run the project, execute the following command:

npm start

Run tests

To run tests, run the following command:

npm run test

(back to top)

👥 Author

👤 Abeera Tahir

• GitHub: @AbeeraTahir
• Twitter: @AbeeraTahir8
• LinkedIn: Abeera Tahir

(back to top)

🔭 Future Features

• Cryptocurrency search can be done by price, market cap, or ranking etc.
• "Show more" button feature for the cryptocurrency list can be added in the Home Page
• Error page can be displayed on API failure

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

Original design idea by Nelson Sakwa on Behance

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)