https://github.com/cancelei/stock-exchange-app

Main learning points: Use React with Redux. Done while doing Microverse Coding School.
https://github.com/cancelei/stock-exchange-app

react

Last synced: 14 days ago
JSON representation

Main learning points: Use React with Redux. Done while doing Microverse Coding School.

• Host: GitHub
• URL: https://github.com/cancelei/stock-exchange-app
• Owner: cancelei
• License: mit
• Created: 2023-08-13T00:28:28.000Z (over 1 year ago)
• Default Branch: development
• Last Pushed: 2023-08-18T23:38:53.000Z (about 1 year ago)
• Last Synced: 2024-10-10T08:42:30.337Z (about 1 month ago)
• Topics: react
• Language: JavaScript
• Homepage: https://cancelei.github.io/Stock-Exchange-APP/
• Size: 2.79 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        





  
 STOCK EXCHANGE APP 




# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ (OPTIONAL)](#faq)

- [📝 License](#license)

# 📖 STOCK EXCHANGE APP

This project is a Stock Exchange App that allows users to search, view details and of stocks in real time. Eventually, the user can also add stocks to their favorites list and remove them from the list.

- LIVE PREVIEW: [Stock Exchange App](https://cancelei.github.io/Stock-Exchange-APP/#/)

- [LIVE DEMO (2min)](https://www.loom.com/share/7c7b047a9a9341f09b552c538c4c3242?sid=3031713e-90e0-460b-abcd-8caef901a313)

## 🛠 Built With:

- React

- Redux

- Stock API

- HTML

- CSS

- JavaScript

### Tech Stack 

  Client

  


    
HTML

    
CSS

    
JavaScript

    
React

    
Redux


  


### Key Features 

- User can view a list of stocks.

- User can view details of a stock.

(back to top)


## 💻 Getting Started 

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

### Prerequisites

Before you proceed, ensure that you have the following installed on your machine:

- Node.js (v12 or above)

- npm (Node Package Manager)

### Setup

Clone this repository to your desired folder:

```sh

  git clone [email protected]:cancelei/Stock-Exchange-APP.git

```

### Install

Install the project dependencies with:

```sh

  npm install

```

### Usage

To run the project, execute the following command:

```sh

  npm run build

```

### Run tests

To run tests, run the following command:

```sh

  npm start

```

- Open your web browser and visit http://localhost:8080.

- You should now see the Space Traveler's Hub application running in your browser.

(back to top)


## 👥 Authors 

👤 **Glauber Bannwart**

- GitHub: [@cancelei](https://github.com/cancelei)

- LinkedIn: [LinkedIn](https://linkedin.com/in/gbannwart)

(back to top)


## 🔭 Future Features 

- User can add a stock to their favorites list.

- User can remove a stock from their favorites list.

- User can view their favorites list.

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome! Please consider this issue link: [Project Issues](https://github.com/cancelei/Stock-Exchange-APP/issues)

## ⭐️ Show your support 

If you like this project kindly leave a star!

(back to top)


## 🙏 Acknowledgments 

I am gratefull for Microverse.

Credits to [Nelson Sakwa](https://www.behance.net/sakwadesignstudio) the [author of the original design](https://www.behance.net/gallery/31579789/Ballhead-App-(Free-PSDs)), in accordance with [Creative Commons License](https://creativecommons.org/licenses/).

## 📝 License 

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

(back to top)