https://github.com/nelofarzabi/finmarket-watchdog

MFINMARKET WATCHDOG is a powerful webapp designed to keep you informed about active financial market companies. Whether you're an investor, trader, or simply interested in the financial markets, this application provides you with up-to-date information on a wide range of companies, including their details and performance metrics.
https://github.com/nelofarzabi/finmarket-watchdog

api linters reactjs redux-toolkit testing

Last synced: 26 days ago
JSON representation

MFINMARKET WATCHDOG is a powerful webapp designed to keep you informed about active financial market companies. Whether you're an investor, trader, or simply interested in the financial markets, this application provides you with up-to-date information on a wide range of companies, including their details and performance metrics.

• Host: GitHub
• URL: https://github.com/nelofarzabi/finmarket-watchdog
• Owner: Nelofarzabi
• License: mit
• Created: 2023-09-04T05:41:42.000Z (over 1 year ago)
• Default Branch: dev
• Last Pushed: 2023-09-19T09:36:58.000Z (over 1 year ago)
• Last Synced: 2024-11-08T07:54:43.720Z (3 months ago)
• Topics: api, linters, reactjs, redux-toolkit, testing
• Language: JavaScript
• Homepage: https://comforting-stardust-96a724.netlify.app/
• Size: 2.68 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)

- [📖 \[FINMARKET WATCHDOG\] ](#-finmarket-watchdog-)

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

    - [Tech Stack ](#tech-stack-)

    - [Key Features ](#key-features-)

     - [🚀 Live Demo](#live-demo)

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

    - [Prerequisites](#prerequisites)

    - [Setup](#setup)

    - [Install](#install)

    - [Usage](#usage)

    - [Run tests](#run-tests)

  - [👥 Authors ](#-authors-)

  - [🤝 Contributing ](#-contributing-)

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

  - [🙏 Acknowledgments ](#-acknowledgments-)

  - [📝 License ](#-license-)

# 📖 [FINMARKET WATCHDOG] 

**[MFINMARKET WATCHDOG]**  is a powerful webapp designed to keep you informed about active financial market companies. Whether you're an investor, trader, or simply interested in the financial markets, this application provides you with up-to-date information on a wide range of companies, including their details and performance metrics.

## 🛠 Built With 

### Tech Stack 

  HTML5

  


    
HTML5

  


  Tailwind

  


    
Tailwind

  


Javascript

  


    
Javascript

  


  React

  


    
React

  


### Key Features 

1. Company List: View a comprehensive list of active financial market companies.

2. Company Details: Access detailed information about each company, including but not limited to:

* Company Name

* Company CEO

* Ticker Symbol

* Industry

* Dividend Yield

* And more...

3. Search Functionality: Easily search for specific companies using their names or ticker symbols.

(back to top)


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

npm

### Setup

Clone this repository to your desired folder:

Example commands:

` git clone https://github.com/Nelofarzabi/finmarket-watchdog.git `

`cd finmarket-watchdog`

`git checkout dev`

### Install

Install this project with:

- npm install

### Usage

To run the project, execute the following command:

- npm start

### Run tests

To run tests, run the following command:

- npm test

(back to top)


### Live Demo

[Live Demo ](https://comforting-stardust-96a724.netlify.app/

## 👥 Authors 

👤 **Nelofar Zabi**

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

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

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/nelofar-zabi-1a1066213)

(back to top)


## 🔭 Future Features 

- [ ] **[Add  transitions or animations]**

- [ ] **[Add more pages]**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Nelofarzabi/finmarket-watchdog/issues).

(back to top)


## ⭐️ Show your support 

If you like this project give it a star!

(back to top)


## 🙏 Acknowledgments 

I would like to thank Microverse for this great opportunity and also to  [Nelson Sakwa](https://www.behance.net/sakwadesignstudio) for creating the Original design on Behance.

(back to top)


## 📝 License 

This project is [MIT](https://github.com/Nelofarzabi/finmarket-watchdog/blob/dev/LICENSE) licensed.

(back to top)