README.md

Prep'd

Looking to ace your next job interview and land your dream job? Look no further than Prep'd – the revolutionary app that transforms job interview preparation into an immersive and effective experience.

Prep'd offers a comprehensive suite of features that are designed to help job seekers build the skills, confidence, and materials they need to succeed in today's competitive job market. With Prep'd, users can:

• Engage with an interactive 3D chatbot that simulates a job interview, providing personalized feedback and recommendations on how to improve their responses.

• Sharpen their programming skills with a variety of coding challenges, evaluated in a safe sandbox environment.

• Create the perfect cover letter, tailored to their specific experience and job requirements, with the help of our AI-powered generator.

• Review an existing cover letter and receive critiques and recommendations as well as generate an optimized version, ensuring that it stands out from the crowd and highlights their unique qualifications.

• Track their progress and insights, gaining valuable feedback on their skills and improvements over time.

Whether you're just starting your job search or looking to take your career to the next level, Prep'd is the ultimate tool for success. With cutting-edge technology and personalized guidance, you'll be ready to ace any job interview and land the job of your dreams.

Table of Contents

• Getting Started
• Running the app
• Alternatively:
  • Back End
  • Front End
• Tech Stack
• Authors

Getting Started

Before moving ahead, you will need to create a Cloudinary account to save your recordings and create an upload preset (a repository for saving your Cloudinary files). You will also need an API key from OpenAI.

In the /client folder, create a file called .env.local:

touch .env.local

Copy the contents of the .env.sample file into the .env file and add your data

In the /server folder, create a file called .env:

touch .env

Copy the contents of the .env.sample file into the .env file and add your data

Running the app

In order to install all the required dependencies, open a terminal from the root folder and run:

npm install

Once the installation is completed, simply run:

npm run start:server-client

To obtain a comprehensive summary of the API endpoints, please refer to this Postman collection.

Alternatively:

Back End

From the root folder, cd into the /server folder and run npm i in order to install all dependencies.

Open 'node_modules/pdf-parse/index.js'

Change line 6 to:

let isDebugMode = false;

Once this is done, run npm run server to initiate the server on port 4000.

Front End

Open another terminal and cd into the /client folder. If you are still in the server folder, cd .. into the root folder first, before moving into the client.

Once in the client folder, install all dependencies using npm i. Then, run npm start to run the scripts and connect the front end. Once all of the above steps are taken, open http://localhost:3000 with your browser to see the result.

Tech Stack

Frontend:

Backend:

Speech to Text:

Animation:

Image and Audio Hosting:

Authentication:

Authors

Boryana Micheva - Github

Colin Howard - Github

Darian Pirowhedayati - Github

David Chamberlain - Github

Elise Verhoeye - Github

Sarah Lash - Github