📗 Table of Contents
- 📖 About the Project
- 💻 Getting Started
- 👥 Authors
- 🤝 Contributing
- ⭐️ Show your support
- 🙏 Acknowledgements
- 📝 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
💻 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 orgit 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 runnpm 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 runnpm 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
- Twitter: @Gerfieldt
- LinkedIn: Kolapo Akinrinlola
🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
⭐️ 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:
📝 License
This project is MIT licensed.