Abdelaziz-Mahdi/Most-Gainers

"Most Gainers" is a website that displays the stock market of most gainers companies. It is a Single Page App (SPA) that allows users to watch live data about the biggest percentage change in supported stocks which returns the most gainers. As fields, it returns the ticker, name, change, and percentage change.

Most-Gainers

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🎥 Project Presentation
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Most-Gainers

"Most Gainers" is a website that displays the stock market of most gainers companies. It is a Single Page App (SPA) that allows users to watch live data about the most significant percentage change in supported stocks which returns the most gainers. It returns the ticker, name, change, and percentage change as fields.

🛠 Built With

Tech Stack

Languages & bundlers

• JSX
• CRA
• Jest

Server

• Render

Database

• Stock Market Most Gainers API

Key Features

• Use GitFlow.
• Single page React app.
• Consume app data from API.

(back to top)

🎥 Project Presentation

Walking through portfolio outline.

• Project Presentation Link

(back to top)

🚀 Live Demo

• Most-Gainers Live Demo // Press Ctrl + click to open the link in a new tab.

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

• Install Node.js.
• Visual Studio Code or equivalent.
• Internet Browser

Setup

Clone this repository to your desired folder:

• cd my-folder
• git clone https://github.com/Abdelaziz-Mahdi/Most-Gainers.git

Install

Install this project with:

• cd my-project
• git config --global --add safe.directory my-directory/my-folder/my-project

Usage

To run the project, execute the following command:

• code .
• npm install
• npm start

Run tests

To run tests, run the following command:

npm test

Deployment

You can deploy this project using the following:

• Render.

(back to top)

👥 Authors

👤 Abdelaziz Ali

• GitHub: @Abdelaziz-Mahdi
• Twitter: @_AbdelazizMahdi
• LinkedIn: in/abdelaziz-mahdi

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

• Template used in the project provided by (Microverse)!
• Original design idea by Nelson Sakwa on Behance. If you liked the original design that inspired this project, I recommend you visit Nelson Sakwa's Behance post. and follow him on Behance to support her work.

(back to top)

📝 License

This project is MIT licensed.

(back to top)