Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/errytagedesign/microverse-finmarket
A web-app to get updated financial statements in real time, every statements is audited, standardized, and up to date. It cover NYSE, NASDAQ, AMEX, EURONEXT, TSX, INDEXES, ETFs, MUTUAL FUNDS, and FOREX.
https://github.com/errytagedesign/microverse-finmarket
Last synced: 19 days ago
JSON representation
A web-app to get updated financial statements in real time, every statements is audited, standardized, and up to date. It cover NYSE, NASDAQ, AMEX, EURONEXT, TSX, INDEXES, ETFs, MUTUAL FUNDS, and FOREX.
- Host: GitHub
- URL: https://github.com/errytagedesign/microverse-finmarket
- Owner: Errytagedesign
- License: mit
- Created: 2023-09-06T07:40:32.000Z (over 1 year ago)
- Default Branch: dev
- Last Pushed: 2023-09-08T14:20:55.000Z (over 1 year ago)
- Last Synced: 2024-10-27T21:21:28.696Z (2 months ago)
- Language: JavaScript
- Size: 701 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Financial Market Capstone project
# 📗 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 Linters](#run-linters)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
# 📖 Financial Market Capstone project
Financial Market Capstone project developed with React, gitflow, and githubflow. In addition, i added Linters for Css and Javascript.
1-Reactjs
2-Css
3-Js
Client
- Initial setup with CRA.
- Add Redux-toolkits.
- Fetch data from APIs.
- Render Data.
- Add Linters.
- Add Unit testing
[Lve Demo Link](https://finmarket.netlify.app/)
### Prerequisites
1-Web Browser
2-Code Editor
3-Git
### Setup
Clone this repository to your desired folder:
Run this Command:
```sh
cd my-folder
git clone https://github.com/Errytagedesign/microverse-finMarket
```
### Install
First you need to install the node package files
Run this command:
```sh
cd microverse-finMarket
npm install
```
### Usage
- In order to use this project you either create branch to add more features.
- But in order to run the project run npm start
- Run npm run build when you're done.
### Run Linters
I have added the linters or tests in order to avoid anykind of typos and ensure the good practices in this project. So while using this repository if you need to check your work in html and css you can use below commands
- in order to run the linter test on index.html:
```sh
npx eslint "**/*.{js,jsx}"
```
- in order to run the linter test on stylesheets:
```sh
npx styleint "**/*.{css,scss}"
```
### Deployment
- You can easily use github pages, netlify or vercel to deploy your project
Useful link about Github Pages
Step by Step guide to deploy using netlify
Step by Step guide to deploy using vercel
👤 Sodeeq Awoyemi
- GitHub: [@githubhandle](https://github.com/Errytagedesign)
- Twitter: [@twitterhandle](https://twitter.com/errytage)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/errytagedesigns/)
- [ ] Add different category like gainers, looser, annual report quarter report etc
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project just give it a star -
I would like to thank Microverse.
- This project was based on the design by [Nelson Sakwa](https://www.behance.net/sakwadesignstudio) in [Behance]().
- The design is licensed under the [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/).
This project is [MIT](./LICENSE) licensed.