README.md

Microverse README Template

📗 Table of Contents

• 📗 Table of Contents
• 📖 [BitTicker]
  • 🛠 Built With Javascript, Javascript Events, Binance API, Linters, npm, Gitflow, Jest, React Testing Library
    • Tech Stack Javascript, React, Redux
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ
  • 📝 License

📖 [BitTicker]

Your final stop for crypto statistics and analysis. Get a look of the current performance of your favorite bitcoin

[BitTicker] is a mobile web application that displays a list of metrics (crypto statistics) created with React and Redux.

🛠 Built With Javascript, Javascript Events, Binance API, Linters, npm, Gitflow, Jest, React Testing Library

Tech Stack Javascript, React, Redux

Describe the tech stack and include only the relevant sections that apply to your project.

Client

• React.js
• Redux.js

Server

• Node.js

Database

Key Features

• [The app fetch statistics of top 100 crypto currencies from the Binance API and lists the top 20]
• [The user can search for more currencies outside those displayed]
• [The app displays the detail of any currency the user selects]

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

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

run the following commands in your terminal

Prerequisites

In order to run this project you need:

You need to have node installed

Setup

Clone this repository to your desired folder:

• git clone https://github.com/JonahKayizzi/BitTicker.git
• cd BitTicker
• git checkout dev

Install

Install this project with:

npm install

Usage

To run the project, execute the following command:

run npm start

Run tests

To run tests, run the following command:

run npm test

Deployment

You can deploy this project using:

run npm build

(back to top)

👥 Authors

Mention all of the collaborators of this project.

👤 Author1

• GitHub: @JonahKayizzi
• Twitter: @JonahKayizzi
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Write a message to encourage readers to support your project

If you like this project, please leave star

(back to top)

🙏 Acknowledgments

Give credit to everyone who inspired your codebase.

I would like to thank Nelson Sakwa on Behance for this [Original design](https://www.behance.net/gallery/31579789/Ballhead-App-(Free-PSDs)

I would like to thank @Binance for this public API

(back to top)

❓ FAQ

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