Skip to main content

Introduction

Welcome to CueHired Documentation! CueHired is a modern recruitment and hiring platform designed to streamline the interview and hiring process.

What is CueHired?

CueHired is a comprehensive hiring platform that helps organizations manage their recruitment process efficiently. It provides features for job posting, candidate management, interview scheduling, and organization management.

Key Features

  • Authentication & Authorization: Secure user authentication and role-based access control
  • Organization Management: Manage company profiles and team structures
  • Job Management: Create, manage, and track job postings
  • Interview Management: Schedule and conduct interviews with candidates
  • Modern Tech Stack: Built with NestJS (Backend) and React (Frontend)

System Architecture

CueHired consists of two main components:

Backend (NestJS)

  • GraphQL
  • Modular design with separate modules for:
    • Authentication
    • Organization Management
    • Job Management
    • Interview Management
  • TypeScript-based development
  • PostgreSQL database

Frontend (React)

  • Modern React application with TypeScript
  • Responsive UI using Tailwind CSS
  • Component-based architecture
  • Vite for fast development and building

Getting Started

To get started with CueHired, you can:

  1. Check out the Installation Guide

Development

The project uses Docker for containerization, making it easy to set up and run locally. For detailed instructions on setting up your development environment, please refer to the Installation Guide.

Contributing

We welcome contributions! Please check back soon for our contributing guidelines.