ProgramKingAbel / metrics-webapp

StoX is a web application for financial institutions that pulls data of available stocks in the market and provides analysis in trends of a particular stock selected by user over a certain period of time e.g 14days in a candlestick graph.

StoX

Project View Screenshots

📗 Table of Contents

• 📗 Table of Contents
• 📖 Stock-X
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 StoX

StoX is a web application for financial institutions that pulls data on available stocks in the market and provides analysis of trends of a particular stock selected by the user over a certain period of time e.g. 14 days in a candlestick graph. This helps traders and investors to make informed and impactful business decisions.

🛠 Built With

Tech Stack

Text Editor

• Visual Studio Code

Client

• HTML
• React.js

Style

• CSS
• React-bootstrap

Test

• React testing library and Jest

Key Features

• Browse through a List of Stocks
• Screening data for each selected Stock
• Graphical analysis for each Stock
• Responsive- Mobile and Desktop versions available

(back to top)

🚀 Live Demo

• Live Demo Link - Available on render
• Live Walkthrough Video - Available on Loom

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

• Browser
• Code Editor
• Node.js

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/ProgramKingAbel/metrics-webapp.git

Install

Install this project with:

  cd metrics-webapp
  npm install

Usage

To run the project, execute the following command:

  npm start

Run tests

To run tests, run the following command:

  npm test

Deployment

You can deploy this project using:

• Free deployment services like GitHub pages.
• Any deployment services of your choice.

(back to top)

👥 Authors

👤 Abel Matunda Morara

• GitHub: @ProgramKingAbel
• Twitter: @ceoabel1
• LinkedIn: Abel Morara

(back to top)

🔭 Future Features

• Access to realtime stock market data
• Trading Dashboard and functionality
• Financial Transaction Services for Stock trading

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(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 and my Coding Partners and Designer of the App Nelson Sakwa on Behance.

(back to top)

📝 License

This project is MIT licensed.

(back to top)