https://github.com/luigirazum/mv-coin-status
React-Redux Capstone Project
https://github.com/luigirazum/mv-coin-status
Last synced: 2 months ago
JSON representation
React-Redux Capstone Project
- Host: GitHub
- URL: https://github.com/luigirazum/mv-coin-status
- Owner: luigirazum
- License: mit
- Created: 2023-04-18T16:35:57.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-05-08T06:58:06.000Z (over 2 years ago)
- Last Synced: 2025-07-25T07:56:29.622Z (3 months ago)
- Language: JavaScript
- Size: 3.74 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### CoinStatus App
CoinStatus App is the MVP of a [SPA](https://en.wikipedia.org/wiki/Single-page_application) 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](#-table-of-contents)
- [🪙 CoinStatus App](#about-project)
- [Preview CoinStatus App](#preview-of-coinstatus-app)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#🚀-live-demo)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Available Scripts](#available-scripts)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [⭐ Show your support ](#-show-your-support-)
- [📝 License ](#-license-)
*CoinStatus App* is the MVP of a [SPA](https://en.wikipedia.org/wiki/Single-page_application) 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.
## 🛠 Built With
### Tech Stack
This project was bootstrapped with:
React
Create React App
Redux Toolkit- *Display a list of Cryptocurrencies.*
- *Select a Cryptocurrency.*
- *Get the details of the Cryptocurrency selected.*
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](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) 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](https://nodejs.org/) to download and install the latest stable version.
- ### Setup
Clone this repository to your desired folder:
```sh
cd my-folder
git clone git@github.com:luigirazum/mv-coin-status.git
```
- ### Install
Install the package dependencies for this project with:
```sh
cd mv-coin-status
npm install
```
### Available Scripts
- #### Run
In the project directory, you can run:
```sh
npm start
```
- Runs the app in the development mode.
- Open [http://localhost:3000](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
```sh
npm test
```
- Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
- #### Build
```sh
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](https://facebook.github.io/create-react-app/docs/deployment) for more information.
- #### Deploy
```sh
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.
👨💻 **Luis Zubia**
- GitHub: **@luigirazum**
- Twitter: **@LuigiRazum**
- LinkedIn: **Luis Zubia**
- [ ] *Store app settings using localStorage.*
- [ ] *Set favorite Cryptocurrencies.*
In order to improve this project, contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
## 🙏 Acknowledgments
- 👏 I would like to thank the support of my partners.
- 👏 Also thanks to [**Nelson Sakwa**](http://sakwadesign.com/) whose [**design guidelines**](https://www.behance.net/gallery/31579789/Ballhead-App-(Free-PSDs)) where used to style this project and they are available under the [Creative Commons license](https://creativecommons.org/licenses/by-nc/4.0/) that requires us to give appropriate credit to the author.
I really enjoyed making this project, so, if you like it, I appreciate your support giving a ⭐.
This project is [MIT](./LICENSE) licensed.