This is a Next.js project bootstrapped with create-next-app. This framework utilizes file-system routing, which means that it automatically sets up routes according to the file system of the project. More about this is found on the NextJs documentation here: (https://nextjs.org/docs/routing/introduction).

Setting up the project for development

Install the following:

Node version 16.17.0
JDK 17.x.x
Maven 3.8.6

Frontend

npm install

Run the development server:

npm run dev

The project runs on port 3000.

General info on architecture

The index.tsx page is the landing page. This redirects to the home dashboard rather than being an actual landing page. Do not confuse it as such. The reason for this is that users are meant to land as quickly as possible at the most relevant dashboard for the user.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Running locally

Running the environment locally requires setting up the database with pgAdmin 4 along with running the backend. Consult the readme for the backend to see how.

Ensure that the backend runs on port 3005, as this is the default we have set the frontend to communicate towards.