Welcome to our Starthack repository. This project follows the Fintech branch and is an express.js application hosted at Starthack Project.

For the purposes of this hackathon, we have also included instructions for hosting this application locally in order to examine and test its features and functionality

This application is runs on node.js, and as such can be locally hosted for testing purposes.

To begin with, you'll need to ensure your device has node.js and npm installed. Visit the official node.js website to install both of these onto your device

To begin with, clone this repository and navigate to folder. Then right click on any empty space and select Open in terminal to get started.

This project makes use of multiple external modules to ensure it can run effectively. In your terminal, write the code below to install these modules in your environment.

npm i cookie-parser cors debug ejs express express-openid-connect http-errors mongodb morgan qrcode vercel

In order to start the server on your local device, run the following code in your terminal:

npm start

Now navigate to localhost:3000 in any web browser and voila!

If you encounter any errors during this process, there are a few possible reasons for them occurring.

1. Ensure that your terminal is opened in the Starthack folder before running any npm installations or starting the server. This is to ensure the packages are installed in the same directory as the code and as such can run properly
2. It is possible that some packages are out of date. In order to resolve this, run the following command in your terminal: npm audit fix --force

This project consists of a landing page and a main app page. The landing page features content regarding the application and what it offers, along with our goals for the future. Once you have explored the landing page, head to the login tab to open your portfolio.

If this is your first time using this application, please create an account by clicking the link at the bottom of the login page

The portfolio displays your available balance and portfolio value, along with the status of your investments to allow you to easily track the performance of the companies you've entrusted your money to.

The explore page features a list of the top 100 ESG scored companies, allowing you to search for a specific one by company code.

This page will contain settings the user can change, such as ui colours, etc.

This application comes with a few callable API's that can be used to obtain information regarding your own account, or to retrieve basic company details.

This endpoint requires a user to enter there authorization token. To retrieve this, head to your Profile page by clicking your username and copy the provided user ID.

This endpoint is a query endpoint, and requires the user to provide a name query when parsing the request. This query can either be in the form of a company code, or simply writing all to receive all available information.

Example query : /api/v1/company?name=KER.PA

Figma

Presentation