- π About the Project
- π» Getting Started
- π₯ Authors
- π Future Features
- π€ Contributing
- βοΈ Show your support
- π Acknowledgements
- β FAQ (OPTIONAL)
- π License
Stock Metrics is a web(mobile-focused) software for monitoring the stock exchange's listed firms and seeing their live metrics. It uses data from the Financial Modeling API.
- HTML
- CSS
- JavaScript
- React
- Webpack
- chart js
- redux
- React Testing Library
- jest
- linter
Client
Server
Database
Describe between 1-3 key features of the application.
- created pages folder for the structure of the pages.
- Wrote tests
- Added a 404 error page
- Added a loader to help keep users waiting while data is being fetched
- Added dynamic routing the details page
- Implemented search bar functionality using reducers and redux store
- Implemented charts to present the dynamically generated net income and gross profit in a line chart and bar chart.
To get a local copy up and running, follow these steps.
In order to run this project you need:
- node.js
- git
Clone this repository to your desired folder:
-
Open your terminal
-
Navigate to the directory where you want to clone the project.
-
Clone the project using by running the following command:
git clone https://github.com/osamaashraf6/Metrices-Webapp.git
Install this project with: node js, run this command npm install
in the terminal
To run the project, execute the following command:
npm run build
npm run start
To run tests, run the following command:
npm run test
You can deploy this project using: npm run deploy
Mention all of the collaborators of this project.
π€ Author1
- GitHub: Osama Ashraf
- Twitter: Osama Ashraf
- LinkedIn: Osama Ashraf
Describe 1 - 3 features you will add to the project.
- I will enhance the code in the future and try to add some new thingsπ―
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
If you like this project feel free to leave a star βοΈ
- I would like to thank Microverse for motivating me to build this beautiful projectπ―
- Original design idea by Nelson Sakwa on Behance.. Under the Creative Commons Licenseπ
-
[How to run this project?]
- [You need to have Node.js in your local machine, and in the root of the project write
npm run start
in the terminal]
- [You need to have Node.js in your local machine, and in the root of the project write
-
[Is it open source?]
- [Yes you are allowed to use this project]
This project is MIT licensed.
NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.