https://github.com/camerodev/stock-metrics
https://github.com/camerodev/stock-metrics
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/camerodev/stock-metrics
- Owner: camerodev
- License: mit
- Created: 2025-04-06T19:17:15.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2025-04-06T19:17:22.000Z (about 2 months ago)
- Last Synced: 2025-04-07T16:43:28.738Z (about 2 months ago)
- Language: JavaScript
- Size: 4.46 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Stock Metrics App
- [Live Demo](https://stock-metrics-clint.netlify.app/)
- [Presentation Video](https://www.loom.com/share/eba6bdff52dc4a3a805a3a98a7a7064c)
> Stock metrics is a web(mobile-focused) app for checking the companies listed on the stock exchange and see their live metrics. Its data is consumed from the [Financial modelling API](https://site.financialmodelingprep.com/developer/docs/). It is built using React, Redux, and React-bootsrap, Skeleton Loader, Recharts.
Additional description about the project and its features.
## Built With
- Major languages (HTML, CSS, JavaScript)
- Frameworks / Libraries
```bash
- React (Front end library)
- React Testing Library
- Jest(for testing)
- Git(version control)
- ESLint(JavaScript linting)
- Stylelint(style linting)
```
- Technologies used
``` bash
- Git(version control)
```
## Getting Started
To get a local copy up and running follow these simple example steps.
### Prerequisites
- A text editor(preferably Visual Studio Code)
### Install
- [Git](https://git-scm.com/downloads)
- [Node](https://nodejs.org/en/download/)
### Usage
#### Clone this repository
```bash
$ [email protected]:clintonjosephs/Stock-metrics.git
$ cd Stock-metrics
```
#### Run project
```bash
$ npm install
$ npm build
$ npm run test
$ npm start
```
#### Open page in browser
```bash
$ runs on http://localhost:3001/
```
## Author
👤 **Clinton Mbonu**
- GitHub: [@clintonjosephs](https://github.com/clintonjosephs)
- LinkedIn: [LinkedIn](https://linkedin.com/in/clinton-mbonu)
- Twitter: [@clintonmbonu2](https://twitter.com/clintonmbonu2)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/clintonjosephs/Stock-metrics/issues).
## Acknowledgement
Original design idea by [Nelson Sakwa on Behance..](https://www.behance.net/gallery/31579789/Ballhead-App-%28Free-PSDs%29) Under the [Creative Commons License](https://creativecommons.org/licenses/by-nc/4.0/)
## Show your support
Give a ⭐️ if you like this project!
## 📝 License
This project is [MIT](https://opensource.org/licenses/MIT) licensed.