Crypto Metrics

📗 Table of Contents

• 📗 Table of Contents
• 📖 Crypto Metrics
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 📄 Project Documentation
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Crypto Metrics

Crypto Metrics is a single page web application that display a list of cryptocurrency coins and their current market info. it allows users to search for coins and filter it by it's names or symbols.

🛠 Built With

Tech Stack

Text Editor

• Visual Studio Code

Client

• HTML
• React.js

Style

• CSS
• React-bootstrap

Test

• React testing library and Jest

Key Features

• Home page for Displaying the Crypto Currencies
• A filter Search Input that Allows filtering coins
• Details page to show details of each coin

(back to top)

🚀 Live Demo

• Live Demo

(back to top)

📄 Project Documentation

• Walk through video

(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:

• Browser
• Code Editor
• Node.js

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/sahlminkok/CryptoMetrics.git

Install

Install this project with:

  cd CryptoMetrics
  npm install

Usage

To run the project, execute the following command:

  npm start

Run tests

To run tests, run the following command:

  npm test

Deployment

You can deploy this project using:

• GitHub pages.
• Render.
• Netlify.

(back to top)

👥 Authors

👤 Sahalu Aminu

• GitHub: @sahlminkok
• Twitter: @sahlminkok
• LinkedIn: sahlminkok

(back to top)

🔭 Future Features

• Add other filter inputs
• Make Navigation Buttons Working
• Add Image for each coin

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project give it a star.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse and the Designer of the App Nelson Sakwa on Behance.

(back to top)

📝 License

This project is MIT licensed.

(back to top)