Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/belsman/react-capstone
This is a frontend web application, developed using React and Redux which lists a catalog of financial values using Stock API.
https://github.com/belsman/react-capstone
react redux
Last synced: 19 days ago
JSON representation
This is a frontend web application, developed using React and Redux which lists a catalog of financial values using Stock API.
- Host: GitHub
- URL: https://github.com/belsman/react-capstone
- Owner: belsman
- Created: 2021-03-19T06:33:28.000Z (over 3 years ago)
- Default Branch: development
- Last Pushed: 2021-04-03T05:25:14.000Z (over 3 years ago)
- Last Synced: 2023-02-26T07:37:35.357Z (over 1 year ago)
- Topics: react, redux
- Language: JavaScript
- Homepage:
- Size: 901 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Project: React-Capstone
## Catalogue of Statistics
This is a frontend web application, developed using React and Redux which lists a catalogue of financial values using [Stock API](https://financialmodelingprep.com/developer/docs/).
The application features
- Display the Most Active Stocks
- Display the Most Gaining Stocks
- Display the Most Losing Stocks
- Open individual stock item and shows further details
- Search for a particular stock item or Stock items, example 'AAPL'
## Live version
🔗 [Click here to go live](https://stockr-belsman.herokuapp.com/)
## Built With
- React
- Redux
- Bootstrap 4
- Font awesome 5
## Run Stockr Locally
To get a local copy up and running follow these simple steps.
### Prerequisites
In order to run **Stockr** locally, you will require the following:
- Nodejs and npm
- An API key for consuming the [Financial Modelling Prep API](https://financialmodelingprep.com/developer/docs/) data
- You are ready to go!
### Install
1) Open the Terminal
2) Run
```sh
git clone https://github.com/belsman/React-Capstone.git
```
or, for SSH:
```sh
git clone [email protected]:belsman/React-Capstone.git
```
3) Run ```cd React-Capstone``` to enter the main directory
4) Run ```npm install```
5) Configure the API KEY
- [Sign up](https://financialmodelingprep.com/developer/docs/) to get an API
- Navigate to the dashboard to copy the API
- Create `.env` file in the current directory, open it and add `REACT_APP_API_KEY=YOUR_API_KEY_HERE`
6) Run `npm start` to launch **Stockr**
7) Happy viewing!
## Testing
1) Open the Terminal
2) Run ```cd React-Capstone``` to enter the root directory of the project
3) Run ```npm test```
## Author
👤 **Bello Babakolo**
- Github: [@belsman](https://github.com/belsman)
- Twitter: [@d_belsman](https://twitter.com/d_belsman)
- Linkdin: [Bello Babakolo](https://www.linkedin.com/in/bello-babakolo-b23b17145/)
## 🤝 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/)