https://github.com/acushlakoncept/react-capstone
In this project, I developed a frontend web application, catalogue of financial values using Stock API, and collect the data from my React Application. It shows the most active stocks, top gainers, and top losers as well the ability to search stocks and show the latest stock news.
https://github.com/acushlakoncept/react-capstone
api react react-api react-redux redux redux-thunk stocks
Last synced: about 1 year ago
JSON representation
In this project, I developed a frontend web application, catalogue of financial values using Stock API, and collect the data from my React Application. It shows the most active stocks, top gainers, and top losers as well the ability to search stocks and show the latest stock news.
- Host: GitHub
- URL: https://github.com/acushlakoncept/react-capstone
- Owner: acushlakoncept
- Created: 2020-12-05T09:33:49.000Z (over 5 years ago)
- Default Branch: development
- Last Pushed: 2020-12-10T12:34:39.000Z (over 5 years ago)
- Last Synced: 2023-08-20T11:14:18.639Z (almost 3 years ago)
- Topics: api, react, react-api, react-redux, redux, redux-thunk, stocks
- Language: JavaScript
- Homepage: https://cush-stocks.herokuapp.com/
- Size: 3.98 MB
- Stars: 11
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# STOCKIST WEB APP - REACT CAPSTONE PROJECT
In this project, I developed a frontend web application, catalogue of financial values using [Stock API](https://financialmodelingprep.com/developer/docs/) and collect the data from my React Application.
The application features includes:
- Listing of Most Active Stocks
- Listing of Most Gainer's Stocks
- Listing of Most Loser's Stocks
- Filter between those 3, most active, gainers and losers
- Open individual stock item
- Search for a particular stock item, example 'AAPL'
- Listing of the lastest stock news
- Dynamic routes for individual stock item, example `/stocks/AAPL`
## Live Demo
[Live Demo](https://cush-stocks.herokuapp.com/)
## Video Presentation
[YouTube Link](https://youtu.be/l5s8WUlm1L8)
## Getting Started
To get a local copy up and running follow these simple example steps.
### Prerequisites
Make sure Node.js is running on your local machine
### Setup
~~~bash
$ git clone https://github.com/acushlakoncept/react-capstone.git
$ cd react-capstone
~~~
Install modules:
```
yarn add
```
Setup your API Key
- I used the [Financial Modelling Prep API](https://financialmodelingprep.com/developer/docs/). Signup and get your key.
- Create `.env` file, open it and add `REACT_APP_API_KEY=xxxxxxxxxxxxxxxxxxxxx`
### Usage
Start server with:
```
yarn start or npm start
```
### Running Test
Jest is used to run all the tests found in this application
In order to run the test you can simply type `yarn test` or `npm run test`
Either ways, if you encounter any error while running either command, its likely you do not have `jest` installed globally, so please run `npm install -g jest-cli` then try again. That should do it.
### Deployment instructions
```
git add .
git commit -m "ready for first push to heroku"
heroku create $APP-NAME --buildpack mars/create-react-app
git push heroku $BRANCH_NAME:master
```
Fire up your app by running `heroku open` Yay!!! your app has been deployed successfully.
# Authors
👤 **Uduak Essien**
- Github: [@acushlakoncept](https://github.com/acushlakoncept/)
- Twitter: [@acushlakoncept](https://twitter.com/acushlakoncept)
- Linkedin: [acushlakoncept](https://www.linkedin.com/in/acushlakoncept/)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check the [issues page](issues/).
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
- [Microverse Inc](https://www.microverse.org/)
- [Financial Modelling Prep API](https://financialmodelingprep.com/developer/docs/)