docs: generate comprehensive README.md with project features
This commit is contained in:
jeremy bayse
99
README.md
99
README.md
@@ -1,58 +1,79 @@
|
||||
<p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400" alt="Laravel Logo"></a></p>
|
||||
# 🚀 RecruIT - QuizzCabm
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/laravel/framework/actions"><img src="https://github.com/laravel/framework/workflows/tests/badge.svg" alt="Build Status"></a>
|
||||
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a>
|
||||
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a>
|
||||
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a>
|
||||
</p>
|
||||
**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.
|
||||
|
||||
## About Laravel
|
||||
## ✨ Main Features
|
||||
|
||||
Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:
|
||||
### 🏢 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.
|
||||
|
||||
- [Simple, fast routing engine](https://laravel.com/docs/routing).
|
||||
- [Powerful dependency injection container](https://laravel.com/docs/container).
|
||||
- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
|
||||
- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
|
||||
- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
|
||||
- [Robust background job processing](https://laravel.com/docs/queues).
|
||||
- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).
|
||||
### 👤 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.
|
||||
|
||||
Laravel is accessible, powerful, and provides tools required for large, robust applications.
|
||||
### 🎓 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.
|
||||
|
||||
## Learning Laravel
|
||||
### 🤖 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.
|
||||
|
||||
Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.
|
||||
### 📊 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.
|
||||
|
||||
In addition, [Laracasts](https://laracasts.com) contains thousands of video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.
|
||||
### 🛠️ 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.
|
||||
|
||||
You can also watch bite-sized lessons with real-world projects on [Laravel Learn](https://laravel.com/learn), where you will be guided through building a Laravel application from scratch while learning PHP fundamentals.
|
||||
## 💻 Tech Stack
|
||||
|
||||
## Agentic Development
|
||||
* **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
|
||||
|
||||
Laravel's predictable structure and conventions make it ideal for AI coding agents like Claude Code, Cursor, and GitHub Copilot. Install [Laravel Boost](https://laravel.com/docs/ai) to supercharge your AI workflow:
|
||||
## 🚀 Getting Started
|
||||
|
||||
```bash
|
||||
composer require laravel/boost --dev
|
||||
### Prerequisites
|
||||
* PHP 8.3+
|
||||
* Composer
|
||||
* Node.js & NPM
|
||||
|
||||
php artisan boost:install
|
||||
```
|
||||
### Installation
|
||||
|
||||
Boost provides your agent 15+ tools and skills that help agents build Laravel applications while following best practices.
|
||||
1. **Clone the repository**
|
||||
```bash
|
||||
git clone <repository-url>
|
||||
cd QuizzCabm
|
||||
```
|
||||
|
||||
## Contributing
|
||||
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.*
|
||||
|
||||
Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
|
||||
3. **Environment Configuration**
|
||||
Edit your `.env` file to configure your database and other service providers.
|
||||
|
||||
## Code of Conduct
|
||||
4. **Start the Development Server**
|
||||
```bash
|
||||
composer run dev
|
||||
```
|
||||
*This starts the Laravel server, Vite dev server, and the queue listener concurrently.*
|
||||
|
||||
In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).
|
||||
## 📜 License
|
||||
|
||||
## Security Vulnerabilities
|
||||
|
||||
If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [taylor@laravel.com](mailto:taylor@laravel.com). All security vulnerabilities will be promptly addressed.
|
||||
|
||||
## License
|
||||
|
||||
The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
|
||||
This project is licensed under the MIT License.
|
||||
|
||||
Reference in New Issue
Block a user