Data

Tools

Indexes

Applications

Experiments

Awesome

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

https://github.com/hfg43/metrics_webapp

S&P 500 Stock Data is an SPA built with React and Redux, that will delivery, price, average price and other key numeric indicatores for the most important companies that operate in the S&P 500 market.
https://github.com/hfg43/metrics_webapp

css react redux

Last synced: 10 months ago
JSON representation

S&P 500 Stock Data is an SPA built with React and Redux, that will delivery, price, average price and other key numeric indicatores for the most important companies that operate in the S&P 500 market.

Awesome Lists containing this project

README 

          


App Screenshot





 S&P 500 Stock Data 








# 📗 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)

  - [Available Scripts](#scripts)

  - [Deployment](#deployment)

- [👥 Authors](#authors)

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

- [🤝 Contributing](#contributing)

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

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

- [🔎 Learn more](#learn-more)



# 📖 "S&P 500 Stock Data" 

S&P 500 Stock Data is an SPA built with React and Redux, that will delivery, price, average price and other key numeric indicatores for the most important companies that operate in the S&P 500 market.



Find here video that shows the project details and functionality:

[Project Video](https://www.loom.com/share/6883e3792432411ab73ca1b1abc411fd?sid=95a16334-332a-490c-b3dc-d066f760d6c5)



You can see a Live Version of my app here: 

[Deployment Link](https://sp500-stockmarket.onrender.com)



## 🛠 Built With 



### Tech Stack 



  CSS

  
    

        
  • The CSS is used to provide the design in the whole page.
    • 

      



  Linters

  
    

        
  • The Linters are tools that help us to check and solve the errors in the code
    • 

        This project count with two linters: 

        
      

            
    • CSS
      • 

            
    • JavaScript
      • 

          
    

      



  React

  



  API

  



### Key Features 



- **SPA**

- **Mobile Desing**

- **Simple interface**

- **React App**

- **React Router**

- **Redux Logged**

- **Redux Toolkit**

- **Implementation of `react-redux`**

- **Test with Jest & React Test Library**



(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:

- **To have a Git in your device** : this is in order to clone and modify this project.

- **To have a code editor** :  such as VS code, Atom or another that you would like to use.

- **To have a web local server such as XAMPP** : this is in with the purpose of you will be able to watch the changes you make in the project.

- **Have basic knowledge about HTML, CSS and JSX** in order to understand the code and be able to modify the elements you want.

- **Count with Node.js in your device** due to it is a tool needed to run the linters



### Setup



Clone this repository to your desired folder:



- Clone this repo on your local device you need to open Git Bash and paste the link with the command

```sh

  cd my-folder-name

  $ git clone https://github.com/HFG43/metrics_webapp

```



### Install



In order can run the linters tools you need use the following commands in your local work environment:



```sh

npm install --save-dev eslint@7.x eslint-config-airbnb@18.x eslint-plugin-import@2.x eslint-plugin-jsx-a11y@6.x eslint-plugin-react@7.x eslint-plugin-react-hooks@4.x @babel/eslint-parser@7.x @babel/core@7.x  @babel/plugin-syntax-jsx@7.x  @babel/preset-react@7.x @babel/preset-react@7.x



npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x

```

**Note:** About the live server server you need to run the following command inside the project.

```

npm start

```



### Usage



To run the project, execute the following command:



In the command line: run `npm start`



### Run tests



To see the linter errors run the following codes for:



`npm run test`



- CSS



```sh

 npx stylelint "**/*.{css,scss}"

  

 To fix the errors add --fix

```



- JS



```sh

 npx eslint "**/*.{js,jsx}"

  

 To fix the errors add --fix

```



### Available Scripts 



In the project directory, you can run:



### `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.



### `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.



### `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.



### `npm run eject`



**Note: this is a one-way operation. Once you `eject`, you can't go back!**



If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.



Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.



You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.



### Deployment



You can find a deployed version of my proyect in the following Render link:



[Deployment Link](https://sp500-stockmarket.onrender.com)



(back to top)



## 👥 Author 



👤 **Hernán Güemes**



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

- Twitter: [@twitterhandle](https://twitter.com/HFG_43)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/hern%C3%A1n-g%C3%BCemes-a440591b/)



(back to top)



## 🔭 Future Features 



- **Add graphs and non numeric KPIs**

- **Desktop Design**



(back to top)



## 🤝 Contributing 



Contributions, issues, and feature requests are welcome!



Feel free to check the [issues page](../../issues/) and add your thoughts



(back to top)



## ⭐️ Show your support 



If you like this project you could clone the repo and work with it or do the changes in a new branch. Also you could let a message with your thoughts



(back to top)



## 🙏 Acknowledgments 



I would like to thank Microverse for provided the necessary resources for this project.



I will also like to acknowledge Nelson Sakwa for the original design idea. You can take a look at his full design in the following link:



[Desing](https://www.behance.net/gallery/31579789/Ballhead-App-(Free-PSDs))



(back to top)



## 📝 License 



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



(back to top)



## Learn More 



You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).



To learn React, check out the [React documentation](https://reactjs.org/).



### Code Splitting



This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)



### Analyzing the Bundle Size



This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)



### Making a Progressive Web App



This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)



### Advanced Configuration



This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)



### Deployment



This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)



### `npm run build` fails to minify