Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/maximoortelli/finance-app

Application that provides comprehensive data on market-leading companies, including financial metrics and market capitalization.
https://github.com/maximoortelli/finance-app

api boostrap css html javascript jest node react redux sass

Last synced: 20 days ago
JSON representation

Application that provides comprehensive data on market-leading companies, including financial metrics and market capitalization.

Host: GitHub
URL: https://github.com/maximoortelli/finance-app
Owner: maximoortelli
License: mit
Created: 2024-04-10T12:55:31.000Z (7 months ago)
Default Branch: main
Last Pushed: 2024-05-05T22:28:51.000Z (6 months ago)
Last Synced: 2024-05-05T23:28:21.358Z (6 months ago)
Topics: api, boostrap, css, html, javascript, jest, node, react, redux, sass
Language: JavaScript
Homepage: https://finance-app-rho-lake.vercel.app
Size: 1.63 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        



    

    Finance App





---

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

- [📝 License](#license)

---

# 📖 Finance App 

- Application that provides comprehensive data on market-leading companies, including financial metrics and market capitalization.

  Access companies profile (Price, Beta, Volume Average, Market Capitalization, Last Dividend, 52 week range, stock price change, stock price change in percentage, Company Name, Sector, website and image link).

---

#### Learning objectives

- Follow a designated [design]().

- Use React documentation.

- Use React components.

- Use React props.

- Use React Router.

- Connect React and Redux.

- Handle events in a React app.

- Write integration tests with a React testing library.

- Use styles in a React app.

- Use React life cycle methods.

- Apply React best practices and language style guides in code.

- Use store, actions and reducers in React.

## 🛠 Built With 

### Tech Stack 

  


    

      

      Redux

    

    

      

      React.js

    

    

      

      JavaScript

    

    

      

      Jest

    

    

      

      SASS

    

    

      

      React-Bootstrap

    

    

      

      HTML

    

  


---

### Key Features 

- **Use of Hooks**

- **Use of State**

- **Use of Redux Toolkit**

- **Use of React Router**

- **Use of React Bootstrap**

(back to top)


---

## 🚀 Live Demo 

- [Finance - Live Demo Link](https://finance-nuqi3fq7d-maximoortellis-projects.vercel.app/)

---

## 💻 Getting Started 

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

### Prerequisites

In order to run this project you need:

### Setup

Clone this repository to your desired folder:

Example commands:

- With SSH:

```bash

  cd my-folder

  git clone https://github.com/maximoortelli/Finance-App.git

```

- With HTTPS:

```bash

  cd my-folder

  git clone https://github.com/maximoortelli/Finance-App.git

```

- With GitHub CLI:

```bash

  cd my-folder

  gh repo clone maximoortelli/finance-metrics-web-app

```

### Install

Install this project's dependencies with:

- npm install

### Usage

To run the project, execute the following command:

```bash

 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.

### Run tests

```bash

 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.

(back to top)


---

## 👥 Authors 

👤 **Arthur ITurres**

- GitHub: [@Maximo Ortelli](https://github.com/maximoortelli)

- LinkedIn: [Maximo Ortelli](https://www.linkedin.com/in/maximo-ortelli-rueda/)

(back to top)


---

## 🔭 Future Features 

- [x] Select the API.

- [x] Build files structure for React app.

- [x] Prepare routes and navigation in app.

- [x] Make sure that a user can display a list of items and filter them.

- [x] Create the tests for the application.

- [x] Style components to match the design provided.

- [x] Deploy the project and test for final details.

- [x] Record a video for your project.

- [x] Enhance Desktop UI/UX.

(back to top)


---

## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/maximoortelli/Finance-App/issues).

(back to top)


---

## ⭐️ Show your support 

Give a ⭐ if you liked this project!

(back to top)


---

## 🙏 Acknowledgments 

I thank the Code Reviewers for their advice and time 🏆

Original [design]() idea by [Nelson Sakwa on Behance](https://www.behance.net/sakwadesignstudio).

(back to top)


---

## 📝 License 

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

(back to top)


---