Files
RecruIT/README.md

80 lines
3.3 KiB
Markdown

# 🚀 RecruIT - QuizzCabm
**RecruIT** (also known as QuizzCabm) is a high-performance, multi-tenant SaaS application designed to streamline and revolutionize the recruitment process through automated assessments, AI analysis, and data-driven decision making.
## ✨ Main Features
### 🏢 Multi-Tenant Architecture
* **Organizational Isolation**: Manage multiple independent companies (tenants) within a single instance.
* **Custom Environments**: Each tenant has its own isolated set of candidates, job positions, and quizzes.
### 👤 Advanced Candidate Management
* **Centralized Tracking**: Monitor candidate progression from application to final selection.
* **Rich Profiles**: Linked profiles with CVs, LinkedIn URLs, phone numbers, and internal recruiter notes.
* **Status Management**: Dynamic statuses and a selection toggle (`is_selected`) for "Shortlisted" candidates.
### 🎓 Dynamic Quiz System
* **Automated Skill Assessment**: Create and manage customizable quizzes for specific job positions.
* **Real-time Scoring**: Automatic calculation of quiz scores with support for manual adjusted scoring if needed.
* **Attempt Tracking**: Monitor when candidates start and finish their assessments.
### 🤖 AI-Powered Analysis
* **Automated Screening**: Integrated AI analysis to evaluate candidate profiles and documents.
* **Smart Insights**: Get data-driven summaries of candidate strengths and weaknesses.
### 📊 Precision Scoring System
* **Weighted Global Score**: A proprietary algorithm calculates a score out of 20 by balancing:
* **CV Evaluation** (20 pts)
* **Motivation** (10 pts)
* **Interview Performance** (30 pts)
* **Best Quiz Attempt** (20 pts)
* **Comparative Dashboard**: Visual tools to compare candidates side-by-side.
### 🛠️ Administrative Excellence
* **Dashboard Analytics**: High-level statistics on candidate throughput, average scores, and top performers.
* **User & Role Management**: Secure access control for administrators and recruiters.
* **Data Integrity**: Built-in backup systems and audit logs of administrative actions.
## 💻 Tech Stack
* **Backend**: [Laravel 13+](https://laravel.com) (PHP 8.3+)
* **Frontend**: [Vue 3](https://vuejs.org/) via [Inertia.js](https://inertiajs.com/)
* **Styling**: [Tailwind CSS](https://tailwindcss.com/)
* **Interactivity**: [Ziggy](https://github.com/tighten/ziggy) for Laravel routing in JS
* **Parsing**: [PDFParser](https://www.pdfparser.org/) for automated document reading
## 🚀 Getting Started
### Prerequisites
* PHP 8.3+
* Composer
* Node.js & NPM
### Installation
1. **Clone the repository**
```bash
git clone <repository-url>
cd QuizzCabm
```
2. **Run Initialization Script**
RecruIT comes with a built-in setup command:
```bash
composer run setup
```
*This command will install dependencies (PHP & NPM), generate the application key, run migrations, and build assets.*
3. **Environment Configuration**
Edit your `.env` file to configure your database and other service providers.
4. **Start the Development Server**
```bash
composer run dev
```
*This starts the Laravel server, Vite dev server, and the queue listener concurrently.*
## 📜 License
This project is licensed under the MIT License.