Hireable LogoHireable

Hireable Documentation

Complete developer documentation for the Hireable talent marketplace platform - a monorepo built with Next.js 16, React 19, and Express

Welcome to the Hireable developer documentation. This guide covers everything you need to build and integrate with the Hireable platform.

Overview

Hireable is a talent marketplace platform built as a TurboRepo monorepo consisting of:

  • Frontend (apps/web) - Next.js 16 application with React 19
  • Backend (apps/api) - Express API server
  • Shared Packages - Reusable types, utilities, and database models
SectionDescription
Getting StartedInstallation, configuration, and project setup
Frontend ArchitectureVertical-slice architecture, components, and patterns
Backend APIExpress API, routes, controllers, and database
API ReferenceComplete REST API specification

Tech Stack

LayerTechnology
MonorepoTurboRepo 2.3.0
FrameworkNext.js 16.0.3 with App Router
UI LibraryReact 19.0.0
BackendExpress 4.18.2
DatabaseMongoDB with Mongoose 9.0.0
StylingTailwind CSS 4.1.17
ComponentsRadix UI, Framer Motion 12.23.24
3D GraphicsThree.js 0.181.2 with React Three Fiber 9.4.0
Type SafetyTypeScript 5.7.2
ValidationZod 4.1.13
TestingVitest 4.0.9, Playwright 1.57.0
Code QualityESLint 9.39.1, Prettier 3.4.2, Knip 5.69.1

Monorepo Structure

hireable-monorepo/
├── apps/
│   ├── web/                  # Next.js Frontend (Port 3000)
│   └── api/                  # Express Backend (Port 3001)
├── packages/
│   ├── shared/               # Shared types, utils, and schemas
│   ├── database/             # MongoDB models and connection
│   ├── config/               # Shared configuration
│   └── ui/                   # Shared UI components
├── package.json              # Root configuration
└── turbo.json                # TurboRepo configuration

Key Features

  • Vertical-Slice Architecture - Feature-first organization for scalability
  • Role-Based Access Control - Comprehensive RBAC with permission guards
  • Type-Safe API - Shared types between frontend and backend
  • Modern React Patterns - Hooks, Context, and Server Components
  • Comprehensive Testing - Unit, integration, and E2E tests

Prerequisites

  • Node.js 20.x or higher
  • npm 10.x or higher
  • MongoDB (local or Atlas)

Getting Started

# Clone and install
git clone <repository-url>
cd hireable-monorepo
npm install
 
# Configure environment
cp .env.example .env.local
 
# Start development
npm run dev

Your applications will be available at:

On this page