Giter VIP home page Giter VIP logo

ab-noori / cryptopanel Goto Github PK

View Code? Open in Web Editor NEW
20.0 1.0 0.0 2.8 MB

Cryptopanel is a single page web app that is created using React and Redux and fetches data from CoinGecko API. The application allows users to get details of cryptocurrencies information.

Home Page: https://ab-noori.github.io/Cryptopanel

License: MIT License

HTML 6.46% JavaScript 72.64% SCSS 20.90%
api create-react-app cryptocurrencies cryptocurrency-api cryptocurrency-app gh-pages-site react-components react-hooks react-redux react-router

cryptopanel's Introduction

Crypto Panel

Desktop View Representation
screenshot
screenshot
screenshotscreenshot

๐Ÿ“— Table of Contents

๐Ÿ“– [Crypto Panel]

[Cryptopanel] is Cryptopanel is a single-page web app that is created using React and Redux and fetches data from CoinGecko API. The application allows users to get details of cryptocurrency information.

๐Ÿ›  Built With

Tech Stack

Key Features

  • [Responsive layout]
  • [UX/UI accessibility]
  • [Dynamic data]

(back to top)

๐Ÿš€ 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:

  • A browser of your choice.
  • A text editor of your choice.
  • An installed node.js on your local system

Setup

Clone this repository to your desired folder:

  • Use the following Commands:

    cd your-desired-folder
    git clone [email protected]:ab-noori/Cryptopanel.git
    

Install

  • Install this project with:

     npx create-react-app .
     npm start
    

Usage

  • Use the following commands to run the project on your local system:

    npm run build
    npm run deploy
    

Run tests

  • Run the following script and style test:

    npx eslint "**/*.{js,jsx}"
    npx eslint "**/*.{js,jsx}" --fix
    
    npx stylelint "**/*.{css,scss}"
    npx stylelint "**/*.{css,scss}" --fix
    

Deployment

  • 1- install gh-pages with following command:

    npm i gh-pages
    
  • 2- Add homepage to project's jason file:

    "homepage": "https://ab-noori.github.io/Cryptopanel",
    
  • 3- Add the following scripts to the project's package.jason file:

    "predeploy": "npm run build",
    "deploy": "gh-pages -d build ",
    
  • 4- Finally run the following command:

    npm run deploy
    

(back to top)

๐Ÿ‘ฅ Authors

๐Ÿ‘ค Abdul Ali Noori

๐Ÿ”ญ Future Features

  • [Giving funtionality to search input]
  • [Creating more professional sidebar panel]
  • [Using charts and graph to disply the currencies data]

(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

First, I would like to thank Microverse and my coding partners. Second, I want to give credit to Nerd's lesson YouTub Channel, its react tutorial is really helpful, and third, I should give credit to Nelson Sakwa, I got some inspirations from his design on Behance.

(back to top)

โ“ FAQ (OPTIONAL)

  • How to make it mobile friendly?

    • Put a viewport tag in the header
  • How to design the site?

    • Draw a mockup before starting to code

(back to top)

๐Ÿ“ License

This project is MIT licensed.

(back to top)

cryptopanel's People

Contributors

ab-noori avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.