hernandanielzamora/Stock-Data

Welcome to CryptoCurrency Tracker! CCT Is a SPA (single-page application) where you cand find information about the best 30 cryptocurrency at the market right now. Our application fetches the information from this API, and displays it in a well structured page, where the user can also look for a crypto in particular

CryptoCurrency Tracker (CCT)

Readme

📗 Table of Contents

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

CryptoCurrency Tracker

Welcome to CryptoCurrency Tracker! CCT Is a SPA (single-page application) where you cand find information about the best 30 cryptocurrency at the market right now. Our application fetches the information from this API, and displays it in a well structured page, where the user can also look for a crypto in particular

Mobile

Desktop

🛠 Built With

Tech Stack

Client

• React
• Redux
• Jest (Testing)

Key Features

• [Home Page]
• [Details Page]
• [Search functionality]

(back to top)

🚀 Live Demo

• Live Demo

(back to top)

💻 Getting Started

Setup

Clone this repository to your desired folder:

1 - Go to the <> Code section in the repository.

2 - Select the https tab and copy the url provided.

3 - Use the git clone command in the root of the folder where you will save the project.

Note: For more information you can visit About remote Repositories and Adding and cloning repositories.

Prerequisites

In order to run this project you need:

• Visual Studio Code
• Git
• Npm
• Node
• React
• Jest

(back to top)

Install

Amongisde the prerequisites, you will need to install the following dependencies:

• react-redux
• redux toolkit
• jest
• babel
• prop-types
• react-dom
• react-icons
• react-router and react-router-dom
• uuid

All of these dependencies can be installed with npm

(back to top)

Usage

To run the project, execute the following command in your terminal (inside the project folder):

• npm init
• npm install
• npm start

(back to top)

Run Tests

To run the the tests, you will have to run the following command in the console (inside the project folder):

• npm install

And then you will have to run the following command in the console (inside the project folder):

• npm test

You will see the outcome in the console

(back to top)

Deployment

To deploy this project in a local enviroment, you will have to run:

• npm start

Then, you will see the project run in a local host: 3000. Otherwise, you can see the project deployed in Render in the live demo.

(back to top)

👥 Author Hernán Zamora

• GitHub: @hernandanielzamora
• Twitter: @HernanZamora14
• LinkedIn: Linkedin

(back to top)

🔭 Future Features

• [Finishing the full website]
• [Adding more cryptos]
• [Creating new pages (about, contact, etc)]

(back to top)

🎥 Project Presentation

• Presentation

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page. Or send them directly to me.

(back to top)

⭐️ Show your support

If you like this project feel free to let me know via Linkedin - Github - Twitter, also don't forget to leave your ⭐️. I will always appreciate your comments.

(back to top)

🙏 Acknowledgments

• Templete used in project provided Nelson Sakwa.
• API used for the data CoinStats.

(back to top)

📝 License

This project is MIT licensed.

(back to top)