Dashboard Frontend and Backend

The Dashboard provides users with the ability to register and login with their Accounts and also provides them access to accessibility features such as User Preferences and Voice Commands. In addition, some features such as Community Space, Onboarding Navigator, Welcome Bot, and Mindful Motion can be found on the dashboard.

API Endpoints

Please look at Installation Steps - Backend. After running the Spring backend, please visit http://localhost:8080/swagger-ui/index.html to see the API Endpoints.

UI Endpoints

Please look at Installation Steps - Frontend. After running the Angular frontend, to access the UI please visit http://localhost:4200. If you have an account created via the Dashboard, then you should use http://localhost:4200/?username=<your username here>.

Modules

Finwise: Finbot is a comprehensive financial assistant that helps users manage budgeting, savings, debt, investments, and retirement planning with personalized advice tailored to their financial goals.

Intelliprep: IntelliPrep helps users become more marketable job candidates by offering practice in articulating responses and setting up mock exams tailored to their expertise.

Code Assistant: Code Assistant assists users in writing code, enhancing efficiency, and streamlining development for a smoother coding experience.

Resrev: Resrev helps users craft standout resumes tailored to specific job descriptions, highlighting their strengths and ensuring optimal structure and formatting for both human and AI reviewers.

Insuretech: Insuretech leverages advanced AI to generate accurate risk assessments, offering comprehensive profiles to support informed insurance decisions.

InsightVision: InsightVision empowers small businesses with AI-driven data visualization, enabling users to upload Excel files, analyze data, and generate dynamic charts and insights for faster, informed decision-making.

MindfulMotion: Mindful Motion helps users relax and recharge by relieving mental and physical tension after long work hours, promoting self-care and well-being.

ResourceCreator: The Resource Creator Module is your all-in-one platform for effortlessly generating high-quality PowerPoints, images, Word documents, Excel spreadsheets, and videos, streamlining workflows and boosting productivity.

Community Space: The Community Space Module showcases all submitted ideas and suggestions in one convenient location.

Onboarding Navigator: Onboarding Navigator streamlines your onboarding process by providing essential resources like git setup instructions and frontend/backend setup guides, with tech leads available for further assistance.

Welcome Bot: A helpful chat bot to provide information about the platform to new users.

Android App: A mobile application that extends the App out to mobile users and allows for the use of native Android functionality.

Installation Steps - Backend

Steps to run the Spring backend (this assumes that you already have a MySQL database instance running at port 3306; if not, please configure this first and remember your username and password):

1. Clone the branch via
   git clone https://github.com/User826/dashboard -b "main"
2. Open the /java-ngf-openai-api folder using Spring Tool Suite IDE.
3. Go To Run -> Run Configurations...
4. Make sure that a configuration under Spring Boot App is selected and that the Project and Main Type fields are filled in (it's a drop-down with only one option each).
5. Go to the Arguments tab, and under VM Arguments add your MySQL database username as -Dspring.datasource.username=<your username here> and the password as -Dspring.datasource.password=<your password here>, then click Apply.
6. Go to the Environment tab, and add your OpenAI apikey as follows:
   Variable: OPENAI_APIKEY, Value: <your OpenAI apikey here>, then click Apply.
7. Finally, click Run to start the backend.

Installation Steps - Frontend

Steps to run the Angular Frontend (this assumes that the Dashboard Backend is already set up and running; if not, please set up the Dashboard Backend to ensure the UI is functioning correctly):

1. Go to the \dashboard folder if you have already cloned the repo as mentioned in Installation Steps - Backend.
2. Run npm install --force (NOTE: You need --force to ensure the correct version of some dependencies are installed).
3. Run ng serve --port 4200 (NOTE: You need to specify the port as 4200 so that there are no conflicts/issues with the dashboard).