Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sambeck87/react_capstone

CRYPTO CURRENCY is a SPA that obtains information on the 100 most important cryptocurrencies worldwide and displays it for viewing. This application provides information as name, symbol, icon, price of several crypto coins
https://github.com/sambeck87/react_capstone

react redux

Last synced: about 1 month ago
JSON representation

CRYPTO CURRENCY is a SPA that obtains information on the 100 most important cryptocurrencies worldwide and displays it for viewing. This application provides information as name, symbol, icon, price of several crypto coins

Awesome Lists containing this project

README

        

logo

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)

# 🚀 CRYPTO CURRENCY

**CRYPTO CURRENCY** is a SPA that obtains information on the 100 most important cryptocurrencies worldwide and displays it for viewing. This application allows you to:

- Display the name, symbol, icon, and current dollar price of the cryptocurrency on the main page.
- Perform a search for the desired item through a text entry.
- Clicking on the desired item opens another page where you can view more information about it.

**You can see a you can see a brief explanation of the application in the following [video](https://www.loom.com/share/617fd05fd0ba41b2aa539dd7d6acf334)**

## 🛠 Built With
- React
- Redux

### Tech Stack
- Visual code
- Git & GitHub

### Key Features

- This is a single page application
- URLs are dinamicaly created
- Use a filter to search a specific element
- Get information from an API
- This is the prototype of the full website

(back to top)

## 🚀 Live Demo

- [Live Demo Link](https://crypto-currency-zbah.onrender.com/)

(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 that supports html5
- Git
- A GitHub account
- Node.js

### Setup

Clone this repository to your desired folder:

- Go to this repo and copy the project link
https://github.com/sambeck87/React_capstone
- Open your terminal and clone the repo with this command
```
git clone https://github.com/sambeck87/React_capstone.git
```
- Now, you have a copy on your pc.

### Install

Install this project with:

- In your console run the command:
```
npm install
```

### Usage

To run the project, execute the following command:

For the preview server:
```
npm start
```

### Run tests

To run tests, run the following command:
```
npm test
```

### Deployment

You can deploy this project using:

- [GitHub pages](https://github.com/sambeck87/React_capstone/settings/pages)
- [Render](https://render.com/)
- [netlify](https://www.netlify.com/)
- [000webhost.com](https://www.000webhost.com/)

This project used render to deploy the page.

(back to top)

## 👥 Authors

👤 **Sandro Hernandez**

- GitHub: [@sambeck87](https://github.com/sambeck87)
- Twitter: [@sambeck4488](https://twitter.com/sambeck4488)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/sandro-israel-hern%C3%A1ndez-zamora-899386a4/)

(back to top)

## 🔭 Future Features

- [ ] **You will be able to save your favorite cryptos**
- [ ] **We will add more crytos**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/sambeck87/React_capstone/issues).

(back to top)

## ⭐️ Show your support

> Write a message to encourage readers to support your project
If you like this project give a ⭐️ or send us a message. We will apreciate

(back to top)

## 🙏 Acknowledgments

The original idea for this template is by [Nelson Sakwa on Behance](https://www.behance.net/gallery/31579789/Ballhead-App-(Free-PSDs)). I appreciate the information provided to make this application a reality.
Also, I would like to thank to Microverse for the inspiration to be better every day.

(back to top)

## ❓ FAQ

- **Can this project be used in any browser?**

- This project was created and proved in firefox v107 and Chrome v109. You can try running it in older versions but this project may not work well.

- **Can I use the code of this project**

- Sure. We will be happy to colaborate with this project. This project is MIT licensed. Remember that the origial idea is by [Nelson Sakwa](https://www.behance.net/gallery/31579789/Ballhead-App-(Free-PSDs)), don't forget thanks him.

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.

(back to top)