https://github.com/libercosoft/stock-market
A stock market web application that gives the details of over 3000 stocks.
https://github.com/libercosoft/stock-market
Last synced: 2 months ago
JSON representation
A stock market web application that gives the details of over 3000 stocks.
- Host: GitHub
- URL: https://github.com/libercosoft/stock-market
- Owner: LIBERCOSOFT
- License: mit
- Created: 2022-11-20T08:47:50.000Z (over 3 years ago)
- Default Branch: development
- Last Pushed: 2023-06-28T12:03:29.000Z (about 3 years ago)
- Last Synced: 2025-03-12T04:44:38.280Z (over 1 year ago)
- Language: JavaScript
- Size: 396 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📗 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)
- [👥 Authors](#authors)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
# 📖 Stock Market
> A web application showing over 3000 stocks, trust, ETFs, and funds.
**Stock Market** is:
## 🛠 Built With
### Tech Stack
Client
### Key Features
- **List over 3000 stocks on the stock market.**
- **Differentiate the stocks into sectors.**
- **Display the details of each selected stock.**
## 🚀 Live Demo
- [Live Demo Link](https://deploy-preview-6--lighthearted-druid-5c17e6.netlify.app/)
## 💻 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 Desktop or Laptop Computer running on with Windows, Mac OS or Linux operating system.
- Have git installed on the Computer
- Have a browser install on the Computer
### Setup
- If it suits you, on your local computer, create a directory in your preferred location (e.g in the Desktop or Document directory).
- Open your Terminal/Powershell or any command line interface you use, then navigate to your created above directory or the directory you'll like to clone this project directory
- Type `git clone https://github.com/LIBERCOSOFT/stock-market.git` if your're using https with git or `git clone git@github.com:LIBERCOSOFT/stock-market.git` if your preferred is ssh and hit enter
### Install
- Navigate to the `stock-market` directory in your above chosen directory in your terminal and run `npm install`.
### Usage
To run the project, execute the following command:
- Navigate to the `stock-market` directory in your above chosen directory in your terminal and run `npm start`.
- Wait for it to load on your localhost on port 3000, and if it doesn't show, go to `http://localhost:3000/` in your browser.
### Run tests
To run tests, run the following command:
- After naviagting to the directory your project files reside, run `npm test`
## 👥 Author
👤 **Kolapo Precious Akinrinlola**
- GitHub: [LIBERCOSOFT](https://github.com/LIBERCOSOFT)
- Twitter: [@Gerfieldt](https://twitter.com/Gerfieldt)
- LinkedIn: [Kolapo Akinrinlola](https://linkedin.com/in/kolapo-akinrinlola-072097110)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
## ⭐️ Show your support
If you like this project, please do give it a star, it goes a long way, thanks.
## 🙏 Acknowledgments
I would like to thank:
- [Nelson Sakwa](https://www.behance.net/sakwadesignstudio)
- [Microverse](https://www.microverse.org/)
- [Financial Modeling Prep](https://financialmodelingprep.com/developer/docs/)
## 📝 License
This project is [MIT](./LICENSE) licensed.