A React/Redux application that fetches and displays financial stocks data in real-time, and presents it in a mobile-style view. The user can query the application for detailed info on a specific company name, and its corresponding stock exchange.
This application uses the public API provided by FinancialModelingPrep
You can always run the app through the live version linked on a previous section. But if you'd like to run it locally, follow the instructions below:
First, you need to have the files on your computer. You can get them by either cloning this repository, or downloading its contents directly
To clone the repository, go on the project's Github page, click on "Clone or download", copy the contents of the text box, and then run git clone "repo" on the command line, where "repo" is the text you just copied. If you want to download it directly instead, go on the project's Github page, click on "Clone or download", and then on "Download ZIP". After this, you need to extract the contents of the zip file on your computer.
Now you need to open a terminal and navigate to the project's directory. Once there, run the command npm install. This is going to fetch and install all the dependencies for the app.
The application requires two environment variables to be set at build time:
- REACT_APP_API_URL=https://financialmodelingprep.com/api/v3
- REACT_APP_API_KEY=(Your personal API key)
You can either initialize those environment variables manually by using the export command in your command-line:
export REACT_APP_API_URL=https://financialmodelingprep.com/api/v3export REACT_APP_API_URL=(Your API key)
Or you can create a .env.development.local file in the base folder of the application, with the following content:
REACT_APP_API_URL=https://financialmodelingprep.com/api/v3
REACT_APP_API_KEY=(Your personal API key)
Once that's done, run the command npm start. That should open a new browser window with the app. If the browser does not open, do it manually, paste this on the url box: localhost:3000, and press enter.
Open a terminal on the base directory for the project and run the command npm test.
- create-react-app
- React
- Redux
👤 Ivan Diaz
-
Contributions, issues and feature requests are welcome!
-
Feel free to check the issues page.
- Give a ⭐️ if you like this project!