From 2a98b948fb5a2cb6490d12a560f4b8d44f1f7732 Mon Sep 17 00:00:00 2001 From: Ananya Date: Fri, 26 Sep 2025 00:04:54 +0530 Subject: [PATCH 1/5] Adding CONTRIBUTING.md --- CONTRIBUTING.MD | 153 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 153 insertions(+) create mode 100644 CONTRIBUTING.MD diff --git a/CONTRIBUTING.MD b/CONTRIBUTING.MD new file mode 100644 index 0000000..10e7ffe --- /dev/null +++ b/CONTRIBUTING.MD @@ -0,0 +1,153 @@ +# Contributing to InterviewAce ๐Ÿš€ + +Thanks for checking out our project. Weโ€™re excited to have you contribute. +We've put together the following guidelines to help you figure out where you can best be helpful. + +--- + +## Table of Contents + +1. [Tech Stacks Used](#-tech-stack) + - [Frontend](#frontend) + - [AI & Computer Vision](#ai--computer-vision) + - [Backend & Database](#backend--database) + - [Data Processing](#data-processing) + - [UI/UX](#uiux) +2. [Prerequisites](#๏ธ-prerequisites) +3. [Here's how to get started](#-how-to-get-started) + - [Installation](#installation) +4. [Project Structure](#๏ธ-project-structure) +5. [Support](#-support) + +--- + +## ๐Ÿ“Œ Tech Stack + +### Frontend + +- **React 18.3.1**: Modern React with hooks and functional components +- **TypeScript 5.5.3**: Type-safe development +- **Vite 5.4.2**: Fast build tool and development server +- **Tailwind CSS 3.4.1**: Utility-first CSS framework +- **React Router 6.20.1**: Client-side routing +- **React Hook Form 7.48.2**: Form management +- **Lucide React 0.344.0**: Beautiful icons + +### AI & Computer Vision + +- **Face-API.js 0.22.2**: Face detection and analysis +- **MediaPipe**: Advanced computer vision capabilities +- **OpenAI API**: GPT models for evaluation +- **Google Gemini API**: Alternative AI evaluation +- **Groq API**: Fast AI inference + +### Backend & Database + +- **Supabase 2.38.4**: Backend-as-a-Service with PostgreSQL +- **Real-time subscriptions**: Live data updates +- **Authentication**: Secure user management +- **File storage**: Document upload and management + +### Data Processing + +- **PDF.js 4.0.379**: PDF parsing and analysis +- **Mammoth 1.6.0**: DOCX file processing +- **PDF-parse 1.1.1**: PDF text extraction + +### UI/UX + +- **React Hot Toast 2.4.1**: Beautiful notifications +- **Chart.js 4.4.0**: Data visualization +- **React Chart.js 2 5.2.0**: React wrapper for Chart.js +- **Date-fns 2.30.0**: Date manipulation utilities + +--- + +## โฎ๏ธ Prerequisites + +- Node.js (v18 or higher) +- npm or yarn package manager +- Modern web browser with camera access (for face monitoring features) + +--- + +## ๐Ÿš€ How to Get Started + +### Installation + +1. **Fork this repository and Clone your forked repository** + + ```bash + git clone + cd Interview01 + ``` + +2. **Install dependencies** + + ```bash + npm install + ``` + +3. **Set up environment variables** + + Supabase Configuration & AI Provider API Keys + >Create a `.env` file in the root directory: + + ```env + VITE_SUPABASE_URL=your_supabase_project_url + VITE_SUPABASE_ANON_KEY=your_supabase_anon_key + + VITE_OPENAI_API_KEY=your_openai_api_key + VITE_GEMINI_API_KEY=your_gemini_api_key + VITE_GROQ_API_KEY=your_groq_api_key + ``` + +4. **Start the development server** + + ```bash + npm run dev + ``` + +5. **Open your browser** + + Navigate to `http://localhost:5173` + +--- + +## ๐Ÿ—๏ธ Project Structure + +```txt +src/ +โ”œโ”€โ”€ components/ # React components +โ”‚ โ”œโ”€โ”€ AITools/ # AI-powered tools +โ”‚ โ”œโ”€โ”€ Auth/ # Authentication components +โ”‚ โ”œโ”€โ”€ Dashboard/ # Main dashboard +โ”‚ โ”œโ”€โ”€ Evaluation/ # Evaluation results +โ”‚ โ”œโ”€โ”€ History/ # Practice history +โ”‚ โ”œโ”€โ”€ Home/ # Landing page +โ”‚ โ”œโ”€โ”€ JobTools/ # Job preparation tools +โ”‚ โ”œโ”€โ”€ Layout/ # Layout components +โ”‚ โ”œโ”€โ”€ Practice/ # Interview practice +โ”‚ โ”œโ”€โ”€ Profile/ # User profile +โ”‚ โ”œโ”€โ”€ Settings/ # App settings +โ”‚ โ””โ”€โ”€ StudyPlan/ # Study plan components +โ”œโ”€โ”€ contexts/ # React contexts +โ”œโ”€โ”€ data/ # Static data and questions +โ”œโ”€โ”€ hooks/ # Custom React hooks +โ”œโ”€โ”€ lib/ # Utility libraries +โ”œโ”€โ”€ pages/ # Page components +โ”œโ”€โ”€ services/ # API services +โ””โ”€โ”€ types/ # TypeScript type definitions +``` + +--- + +## ๐Ÿ“ž Support + +For support, [email us](mailto:support@interviewace.com) or join our [Slack channel](https://your-slack-channel-link). + +--- + +Built with [Om Singhโค๏ธ] for the developer community + +*Transform your interview preparation with AI-powered coaching and real-time feedback.* From 683f6c50ac0a434a051163ba5ffa62fb3a8bb8ac Mon Sep 17 00:00:00 2001 From: Ananya Date: Fri, 26 Sep 2025 00:34:09 +0530 Subject: [PATCH 2/5] Adding CONTRIBUTING.md --- CONTRIBUTING.MD | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.MD b/CONTRIBUTING.MD index 10e7ffe..9d5db53 100644 --- a/CONTRIBUTING.MD +++ b/CONTRIBUTING.MD @@ -1,7 +1,7 @@ # Contributing to InterviewAce ๐Ÿš€ -Thanks for checking out our project. Weโ€™re excited to have you contribute. -We've put together the following guidelines to help you figure out where you can best be helpful. +Thanks for checking the project. I'm excited to have you contribute. +I've put together the following guidelines to help you figure out where you can best be helpful. --- From aa19b31c99166644dd8b1f40a1372e601301400c Mon Sep 17 00:00:00 2001 From: Ananya Date: Fri, 26 Sep 2025 07:34:39 +0530 Subject: [PATCH 3/5] Updated CONTRIBUTING.md --- CONTRIBUTING.MD | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.MD b/CONTRIBUTING.MD index 9d5db53..e17c4e8 100644 --- a/CONTRIBUTING.MD +++ b/CONTRIBUTING.MD @@ -148,6 +148,6 @@ For support, [email us](mailto:support@interviewace.com) or join our [Slack chan --- -Built with [Om Singhโค๏ธ] for the developer community +Built with Om Singhโค๏ธ for the developer community *Transform your interview preparation with AI-powered coaching and real-time feedback.* From 3521e795070991530acb087431297bfbf0d91826 Mon Sep 17 00:00:00 2001 From: Ananya Date: Fri, 26 Sep 2025 07:55:01 +0530 Subject: [PATCH 4/5] Update CONTRIBUTING.MD Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- CONTRIBUTING.MD | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.MD b/CONTRIBUTING.MD index e17c4e8..04b2f6e 100644 --- a/CONTRIBUTING.MD +++ b/CONTRIBUTING.MD @@ -13,10 +13,10 @@ I've put together the following guidelines to help you figure out where you can - [Backend & Database](#backend--database) - [Data Processing](#data-processing) - [UI/UX](#uiux) -2. [Prerequisites](#๏ธ-prerequisites) +2. [Prerequisites](#-prerequisites) 3. [Here's how to get started](#-how-to-get-started) - [Installation](#installation) -4. [Project Structure](#๏ธ-project-structure) +4. [Project Structure](#-project-structure) 5. [Support](#-support) --- From 700d09ea7104f91a9d3c86d988ca0c55f1d11faf Mon Sep 17 00:00:00 2001 From: Ananya Date: Fri, 26 Sep 2025 08:15:09 +0530 Subject: [PATCH 5/5] Updating CONTRIBUTING.md --- CONTRIBUTING.MD | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.MD b/CONTRIBUTING.MD index e17c4e8..604f264 100644 --- a/CONTRIBUTING.MD +++ b/CONTRIBUTING.MD @@ -7,21 +7,21 @@ I've put together the following guidelines to help you figure out where you can ## Table of Contents -1. [Tech Stacks Used](#-tech-stack) +1. [Tech Stacks Used](#tech-stack) - [Frontend](#frontend) - [AI & Computer Vision](#ai--computer-vision) - [Backend & Database](#backend--database) - [Data Processing](#data-processing) - [UI/UX](#uiux) -2. [Prerequisites](#๏ธ-prerequisites) -3. [Here's how to get started](#-how-to-get-started) +2. [Prerequisites](#prerequisites) +3. [Here's how to get started](#how-to-get-started) - [Installation](#installation) -4. [Project Structure](#๏ธ-project-structure) +4. [Project Structure](#project-structure) 5. [Support](#-support) --- -## ๐Ÿ“Œ Tech Stack +## Tech Stack ### Frontend @@ -63,7 +63,7 @@ I've put together the following guidelines to help you figure out where you can --- -## โฎ๏ธ Prerequisites +## Prerequisites - Node.js (v18 or higher) - npm or yarn package manager @@ -71,7 +71,7 @@ I've put together the following guidelines to help you figure out where you can --- -## ๐Ÿš€ How to Get Started +## How to Get Started ### Installation @@ -114,7 +114,7 @@ I've put together the following guidelines to help you figure out where you can --- -## ๐Ÿ—๏ธ Project Structure +## Project Structure ```txt src/