fredo509/CryptoCurrencies-metrics

Cryptocurrencies-Metrics

Cryptocurrencies-Metrics Readme

📗 Table of Contents

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

📖 [Cryptocurrencies-Metrics]

[ Cryptocurrencies-Metrics ] This is a mobile web application used to check a list of crypto metrics. It is created using the coinstats API. The webapp have several pages which includes the "Home page" with a list of items that could be filtered by some parameters; in the project, it's a list of metrics that can be filtered by the coin name and a "Details page" with more information about a selected coin.

🛠 Built With

HTML CSS Components React APIs Redux

Tech Stack

Client

• HTML, CSS, JavaScript, React , API, Redux

Server

• Dev Server

Pakage Manager

• npm

APIs

• Coinstats API

Key Features

• [User can see list of crypto ]
• [User can get more details about a crypto selected]

(back to top)

🚀 Live Demo

• Live Demo Link

(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 web browser to view output e.g Google Chrome.
• An IDE e.g Visual studio code.
• node should be installed in your local machine, node website.
• Install the npm package manager use this to install both node and npm.
• A terminal.

Setup

Clone this repository to your desired folder or download the Zip folder:

https://github.com/fredo509/CryptoCurrencies-metrics.git

• Navigate to the location of the folder in your machine:

you@your-Pc-name:~$ cd Space-Travelers-Hub

Install

To install all dependencies, run:

npm install

Usage

To run the project, follow these instructions:

• After Cloning this repo to your local machine.
• You can use npm start command in terminal to run this at localhost:8080

Run tests

To run tests, run the following command:

• Track HTML linter errors run:

npx hint .

• Track CSS linter errors run:

npx stylelint "**/*.{css,scss}"

• Track JavaScript linter errors run:

npx eslint .

• run test:

npx jest 

Deployment

You can deploy this project using: GitHub Pages,

• I used GitHub Pages to deploy my website.
• For more information about publishing sources, see "About GitHub pages".

(back to top)

👤 Fredo Fleur

• GitHub: fredo509
• Twitter: @Fredo_st_fleur
• LinkedIn: fredo-st-fleur

(back to top)

🔭 Future Features

• [We will make this project responsive to make it look's more attractive]

(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 me a star ⭐️

(back to top)

🙏 Acknowledgments

• Inspiration Nelson Sakwa on Behance
• Microverse student community

(back to top)

• [How this list works]

  • [you can see the list of Rockets and Missions]
  • [you can reserved or Cancel reservation for a rocket and you will see the rocket reserved in myprofile page]
  • [you can join or leave a mission and you will see the mission joined in myprofile page]

(back to top)

📝 License

This project is MIT licensed.

(back to top)