Skip to content

GlennStreetman/finnHub-Dashboard

Repository files navigation

Finndash

A web deployable applicaiton that allows you to quickly design and visualize your Finnhub Stock API data in a dashboard format.
Each dashboard then becomes its own API endpoint that you can query using graphQL.
After you are done designing your dashboards you can push your data to Excel.

Working Example requires going through registration process and working Finnhub.io API Key.

Deployed using Docker & Docker Compose

This project was bootstrapped with Create React App

Setup

Navigate to desired project folder.

git clone https://github.com/GlennStreetman/finnHub-Dashboard.git
NPM install

Create .env file

rename env.example to dev.env for dev mode and prod.env for production. Remember to rerun build after any changes to an env file Login requires Mailgun Account. Remember to add your apikeys to the .env file.

Dev mode

npm run dev-build npm run dUp npm run tsc

On slower systems changes to server take a few seconds transpile and nodemon is too fast. Save twice for server changes to reflect.

If default user or passwords are changed in the .env file make sure to reflect the changes in the corresponding .yaml files

Build for production

npm run prod-build npm run pUp

Use nginx, or favored reverse proxy, to send requests to port 5000

TESTS

Test need to have useRemoteLogin set to false in test.env file.

npm run test-build test-buildEnv npm run testDeploy npm run connect npm run test 'testname'

Debugging Tests

Use break points with the test-debug command, shown below, to debug

npm run test-debug 'testname'

After running test-debug, with the test you want to debug appended to the end of the command go into chrome and navigate to:

chrome://inspect

About

A dashboard designer for your finnhub.io API data.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published