https://github.com/normainobary2021/react-capstone
https://github.com/normainobary2021/react-capstone
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/normainobary2021/react-capstone
- Owner: normainobary2021
- License: mit
- Created: 2022-11-24T17:22:27.000Z (over 2 years ago)
- Default Branch: development
- Last Pushed: 2022-12-08T22:33:04.000Z (over 2 years ago)
- Last Synced: 2025-02-07T22:51:48.917Z (4 months ago)
- Language: JavaScript
- Size: 1.27 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Microverse README Template
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 \[CryptoJaja\] ](#-cryptojaja-)
- [🛠 Built With Javascript, Javascript Events, Binance API, Linters, npm, Gitflow, Jest, React Testing Library](#-built-with-javascript-javascript-events-binance-api-linters-npm-gitflow-jest-react-testing-library)
- [Tech Stack Javascript, React, Redux](#tech-stack-javascript-react-redux)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [Loom Video](#loom-video)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [❓ FAQ ](#-faq-)
- [📝 License ](#-license-)
> The most reliable source for all your crypto statistics and analysis. Have a look at the current performance of your favorite crypto currency in Real-time.
**[CryptoJaja]** 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
Server
Database
- **[The app fetches 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]**
- [Live Demo Link](https://cryptojaja-metrics.netlify.app/)
- [Loom Recording](https://www.loom.com/share/12d2d21fb6934cbaa0519906a5683b31)
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/normainobary2021/react-capstone.git
- cd react-capstone
- 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
> Mention all of the collaborators of this project.
👤 **Norman Ainobushoborozi**
- GitHub: [normainobary2021](https://github.com/normainobary2021)
- Twitter: [@NormanAinobush2](twitter.com/NormanAinobush2)
- LinkedIn: [norman-ainobushoborozi](https://www.linkedin.com/in/norman-ainobushoborozi)
## 🔭 Future Features The following suggestions could be used to improve the next version
> Make the styling alittle more attractive.
> Add ability to trade.
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/normainobary2021/react-capstone/issues).
> Write a message to encourage readers to support your project
If you like this project, please leave star
> Give credit to everyone who inspired your codebase.
I would like to thank [Nelson Sakwa on Behance](https://www.behance.net/sakwadesignstudio) for this [Original design](https://www.behance.net/gallery/31579789/Ballhead-App-(Free-PSDs)
I would like to thank [@Binance](https://github.com/binance) for this [public API](https://github.com/binance/binance-spot-api-docs/blob/master/rest-api.md)
This project is [MIT](./LICENSE.md) licensed.
_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._