luigirazum / mv-coin-status

React-Redux Capstone Project

CoinStatus App

CoinStatus App is the MVP of a SPA application that lets users to:
1) See a list of current Cryptocurrencies,
2) Click on any of the items showed in the list,
3) See the details of the Cryptocurrency selected.

^{It uses an API to retrieve real Cryptocurrency data.}

📗 Table of Contents

• 📗 Table of Contents
• 🪙 CoinStatus App
  • Preview CoinStatus App
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Available Scripts
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • 🙏 Acknowledgments
  • ⭐ Show your support
  • 📝 License

---

🪙 CoinStatus App

CoinStatus App is the MVP of a SPA application that lets users to see a list of Cryptocurrencies, select one of them, see its details.

^{This is a Capstone project and it was built in order to complete the React and Redux module.}

Preview of CoinStatus App.

^{The image above shows the general view for the app.}

(back to top)

🛠 Built With

Tech Stack

This project was bootstrapped with:

• React
• Create React App
• Redux Toolkit

Key Features

• Display a list of Cryptocurrencies.
• Select a Cryptocurrency.
• Get the details of the Cryptocurrency selected.

(back to top)

🚀 Live Demo

• CoinStatus App

(back to top)

💻 Getting Started

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

• Prerequisites

  • In order to run this project locally you need git installed. Please got to Getting Started - Installing Git guide and follow the steps described for your system to install git.

  • You must have Node installed on our machine to access the NPM (Node Package Manager) tool. Run node -v and npm -v in the terminal to see if you have node and npm installed, respectively. Ensure you have node>=14.0.0 and npm>=5.6
    If you don’t have them installed, head to Node to download and install the latest stable version.

• Setup

  Clone this repository to your desired folder:

  cd my-folder
  git clone [email protected]:luigirazum/mv-coin-status.git

• Install

  Install the package dependencies for this project with:

  cd mv-coin-status
  npm install

Available Scripts

• Run

  In the project directory, you can run:

  npm start

  • Runs the app in the development mode.
    • Open http://localhost:3000 to view it in your browser.
  • The page will reload when you make changes.
  • You may also see any lint errors in the console.

• Test

  npm test

  • Launches the test runner in the interactive watch mode.
    See the section about running tests for more information.

• Build

  npm run build

  • Builds the app for production to the build folder.
    • It correctly bundles React in production mode and optimizes the build for the best performance.
  • The build is minified and the filenames include the hashes.
  • Your app is ready to be deployed!
    See the section about deployment for more information.

• Deploy

  npm deploy

  • Deploys the project using gh-pages.
    • Under the hood, it runs npm run build first.
    • The project then is published using github pages.

(back to top)

👥 Authors

👨‍💻 Luis Zubia

• GitHub: @luigirazum
• Twitter: @LuigiRazum
• LinkedIn: Luis Zubia

(back to top)

🔭 Future Features

• Store app settings using localStorage.
• Set favorite Cryptocurrencies.

(back to top)

🤝 Contributing

In order to improve this project, contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

🙏 Acknowledgments

• 👏 I would like to thank the support of my partners.
• 👏 Also thanks to Nelson Sakwa whose design guidelines where used to style this project and they are available under the Creative Commons license that requires us to give appropriate credit to the author.

(back to top)

⭐ Show your support

I really enjoyed making this project, so, if you like it, I appreciate your support giving a ⭐.

(back to top)

📝 License

This project is MIT licensed.

(back to top)