User Manual

Installation Instructions

To install the application on your local machine, please complete the following steps:

1. If you haven't already, install Node.js using the instructions on this page and make sure that you are using version 12.19.0.

2. Install and run PostgreSQL using the instructions here.

3. We get our stock data from finnhub.io , so follow that link and make a free account. Get your API KEY, and save it for step 7.

4. When steps 1, 2 and 3 are completed, head over to the main page of this repository and clone it.

5. Inside the project repository, run the following command to install the required modules: npm run install:all

6. Make sure your PostgreSQL app is running, and then specify the connection string in the #environment variable PG_CONNSTR by executing the following command:

   export PG_CONNSTR="postgresql://username:password@localhost:5432/db_name"

   Also make sure to set your username, password, and db_name accordingly.

7. Add your API KEY from step 3, by running the following command:

   export FINNHUB_API_KEY="YOUR_API_KEY_HERE"

8. Start both the client and server in development mode. See the root directory package.json for more details. npm start

9. Navigate to localhost:3000 by to see the frontend! Backend is hosted in the default port 8080.

User Guide

1. Our application's landing page is the Market page, where most of the action happens 💁. This is what it should look like: