Interview Buddy 2.0

Interview Buddy is an open source platform to help you land your next technical interview. Practice in an interview environment with simulated scenarios and real-time feedback. Build confidence and face interviews with a prepared and positive mindset, ready to shine.

Tech Stack

• Next.js - Framework
• tRPC - API
• TypeScript - Language
• Prisma - ORM
• NextAuth.js - Authentication
• PostgreSql - Database
• Recoil - State Management
• Tailwind - CSS
• shadcn/ui - Component Library

This repository uses Turbo as the Monorepo.

Development

Docker Setup

• Clone the repo to your local machine using the following command :

git clone https://github.com/VK-RED/Interview-Buddy-2.0.git

• Navigate to the project's root folder

cd Interview-Buddy-2.0

• Setup the env variables

cp .env.example .env

• Use openssl rand -base64 32 to generate a key and add it under NEXTAUTH_SECRET in the .env file.

• Use your own API keys for the following environment variables GOOGLE_ID, GOOGLE_SECRET, OPENAI_API_KEY in the .env file

• Install all the dependencies in the root folder using the command

npm i

• Now start running the app at the root folder in terminal, using the command below

docker compose -f docker-compose-dev.yml up

• You can bring down the app by running the command below in the terminal, at the root folder

docker compose -f docker-compose-dev.yml down

• Now if you visit http://localhost:3000 the app should be running up.
• You can visit http://localhost:5555 to see the Prisma Studio for visualising the Database.

Manual Setup

• Clone the repo to your local machine using the following command :

git clone https://github.com/VK-RED/Interview-Buddy-2.0.git

• Navigate to the project's root folder

cd Interview-Buddy-2.0

• Setup the env variables

cp .env.example .env

• Use openssl rand -base64 32 to generate a key and add it under NEXTAUTH_SECRET in the .env file.

• Use your own API keys for the following environment variables GOOGLE_ID, GOOGLE_SECRET, DATABASE_URL, OPENAI_API_KEY in the .env file

• Install all the dependencies in the root folder using the command

npm i

• Generate the Prisma Client using the following command

npm run init:generate

• Run the Prisma Migrations using the following command

npm run init-db

• Now run the Project using the command

npm run dev

• Now you can see your app being served at http://localhost:3000/

• You can run the below command at the root folder to visualize the Database.

npm run studio

After running the command check http://localhost:5555 to see the DB models

What's inside

• The apps folder contains a next-app folder which is a Next.js app

• The packages contains dependencies/folders used by either apps (or) other packages.

  • The packages/ai contains the api for querying OpenAI.
  • The packages/api contains everything related to tRPC. Including procedures, middlewares and context.
  • The packages/auth contains the configurations of NextAuth for the app.
  • The packages/db contains Prisma and it's schema.
  • The packages/eslint-config-custom contains eslint configurations.
  • The packages/tailwindconfigcontains tailwind configuration which is being used by app and the ui package.
  • The packages/tsconfig contains tailwind configurations which is being used by throughout the enire repo.
  • The packages/ui contains the shadcn/ui components. It is re-usable components and being styled using TailwindCSS.
  • The packages/store contains the recoil atoms and selectors.
  • The packages/features contains auxillary libraries used by other packages.

Contributions

I love and welcome open source contributions, if you have any queries, concerns or enhancements which you feel elevate or bring value to the repo, kindly feel free to raise them. Your feedback is valuable and will help me to improve InterviewBuddy 2.0.

To contribute, you can:

• Raise an issue : If you encounter any problems or have suggestions for improvements, please create an issue on this GitHub repository. I will review it and work together with you to find a solution.

• Submit a pull request : If you have a specific improvement in mind, you can fork the repository, make your changes, and submit a pull request. I will review your changes and merge them if they align with the project's goals.

Thank you for your support !!!