HireFlow is a comprehensive recruitment management platform developed as a technical portfolio project to demonstrate a professional, full-stack architecture. Designed to centralize the entire hiring lifecycle—from job opening creation to the final contract—it bridges the gap between candidates and internal teams (HR and Hiring Managers) through a structured, enterprise-grade evaluation pipeline.
HireFlow is built as a decoupled system, mimicking high-scale corporate environments where the frontend and backend live in separate ecosystems.
- hireflow-api: A robust Laravel 11 REST API managing business logic, RBAC, and data persistence.
- hireflow-web: A modern Next.js 14 frontend (🚧 in construction) that consumes the API via strictly typed contracts generated from Swagger.
- Dynamic Pipeline: Candidates move through customizable stages (Screening, Technical Interview, Offer) with a full audit log of every movement.
- Advanced RBAC: Fine-grained permissions for 4 personas:
Candidate,Recruiter,Hiring Manager, andAdmin. - Collaborative Hiring: Internal comments and evaluations that keep the conversation organized within the candidate's profile.
- Async Notifications: Emails and system alerts handled via Redis queues to ensure zero-latency API responses.
- Social Auth: Seamless onboarding via LinkedIn OAuth integration.
- Framework: Laravel 11 / PHP 8.2+
- Database: MySQL 8.0 (Persistence)
- Cache/Queue: Redis 7 (Speed & Async Jobs)
- Auth: Laravel Sanctum (SPA/API) + Socialite (OAuth)
- Documentation: L5-Swagger (OpenAPI 3.0)
- Framework: Next.js 14 (App Router)
- State/Data: TanStack Query + Orval (Auto-generated API clients)
- Laravel Herd (Recommended) or PHP 8.2+
- Docker Desktop (for MySQL and Redis)
- Composer
-
Clone & Install:
git clone https://github.com/your-repo/hireflow-api.git cd hireflow-api composer install -
Environment Setup:
cp .env.example .env php artisan key:generate
_Note: Remember to configure your
DB\__andREDIS\__variables in the.envfile._ -
Database & Infrastructure:
docker compose up -d php artisan migrate --seed
-
Serve: If using Laravel Herd, the project is available at
http://hireflow-api.test. Otherwise, run:php artisan serve
The project includes exhaustive documentation covering every aspect of the system and can all be found in the Wiki of the project:
- Introduction: Project vision and problem-solving.
- Architecture: Deep dive into the dual-system setup.
- Database Schema: Entity-relationship diagrams and UUID strategy.
- Authentication: Sanctum flow and LinkedIn integration.
- Roles & Permissions: The logic behind the RBAC system.
- Recruitment Pipeline: How the stage logic works.
- API Conventions: REST patterns and response standards.
- Use Cases: Step-by-step user journeys.
⚠️ Not all topics that were covered in the wiki are listed here.