Table of Contents

1. About The Project
2. Technologies
3. Getting Started
   • Installation
   • Start
   • Test
4. Demo
5. Contact us

About Career Companion

Career Companion is your ultimate job search assistant.

With us, you can easily track your job applications, manage your interviews, and receive reminders and notifications to stay on top of your job search.

At Career Companion, we understand that job hunting can be a daunting process. That's why we're here to support you every step of the way. Whether you're a recent graduate or an experienced professional, our platform can help you land your dream job.

Technologies

Here's an overview of the technologies used to build this application.

• MongoDB
• Express
• React
• Node.js
• OpenAI API
• Tailwind
• Daisy UI
• Bcrypt
• JWT
• Nodemon
• Jest
• Cypress
• ESLint

Quickstart

Installation

1. install npm

npm install npm@latest -g

2. Clone this repo

git clone https://github.com/francescoGuglielmi/career_companion.git

3. Install NPM dependencies

; cd api
; npm install
; cd ../frontend
; npm install

4. Install MongoDB

brew tap mongodb/brew
brew install [email protected]

5. Start MongoDB

brew services start [email protected]

Start

1. Start the server

; cd api
; JWT_SECRET=SUPER_SECRET npm start

2. Start the front end

In a new terminal session...

; cd frontend
; npm start

Browse to http://localhost:3000/

Test

The Backend (API)

Note the use of an environment variable for the JWT secret

Start the server in test mode (so that it connects to the test DB)

; cd api
; JWT_SECRET=SUPER_SECRET npm run start:test

Then run the tests in a new terminal session

; cd api
; JWT_SECRET=SUPER_SECRET npm run test

The frontend (React)

Note the use of an environment variable for the JWT secret

Start the server in test mode (so that it connects to the test DB)

; cd api
; JWT_SECRET=SUPER_SECRET npm run start:test

Then start the front end in a new terminal session

; cd frontend
; JWT_SECRET=SUPER_SECRET npm start

Then run the tests in a new terminal session

; cd frontend
; JWT_SECRET=SUPER_SECRET npm run test

Demo

• Users can create an account, sign in and out and perform actions as the logged in user.

• Users can add and track job applications, update the status, add key details and add an interview date.

• Users can train for tech job interviews receiving feedback from AI on their answers to the provided questions.

• Users can create a tailored resume

• Users can generate a personalised cover letter through AI.

• Users can leave a review about the quality of the companies's hiring system and rate them.

Live Demo

You can watch a live demo of Career Companion here: https://youtu.be/0VTqKqXxe3Y?t=1528

Contact us

This was a group project, created by:

• Sarah Davies LinkedIn Github
• Konrad Duński LinkedIn Github
• Francesco Guglielmi LinkedIn Github
• Adnan Mann LinkedIn Github
• With thanks to Kassandra Kalejaye for supporting with the planning stages