Resume Builder Backend API

A robust NestJS-powered backend API for a resume builder application with JWT authentication, TypeORM database integration, and AI-powered summary enhancement capabilities.

Features

🔐 Authentication & Authorization

• JWT token-based authentication
• Password hashing with bcrypt
• Protected routes with guards
• User registration and login
• Token expiration handling (1 hour)

👤 User Management

• User registration with validation
• Unique email and username constraints
• Password encryption and secure storage
• User profile management

📋 Resume Management

• Complete CRUD operations for resumes
• User-specific resume access control
• Comprehensive resume sections support
• Cascading deletes for data integrity

📊 Resume Sections

• Skills: Name and description with resume association
• Education: Degree, institution, area of study, date range, GPA
• Experience: Job title, company, date range, description
• Projects: Name, date, link, description
• Certifications: Name, issuer, date, URL, description

🤖 AI Integration

• AI-powered summary enhancement
• Context-aware improvements based on resume content
• RESTful AI enhancement endpoint

📚 API Documentation

• Swagger/OpenAPI integration
• Comprehensive DTO documentation
• Response type definitions
• API property examples

Technology Stack

• Framework: NestJS
• Database ORM: TypeORM
• Authentication: JWT with Passport
• Password Hashing: bcrypt
• Validation: class-validator
• Documentation: Swagger/OpenAPI
• Database: PostgreSQL/MySQL (configurable)

Prerequisites

• Node.js (version 16 or higher)
• npm or yarn package manager
• PostgreSQL or MySQL database
• AI service integration (for summary enhancement)

Installation

1. Clone the repository:

git clone https://github.com/ranaehelal/resume-builder-backend
cd resume-builder-backend

2. Install dependencies:

npm install

Configuration

Environment Variables

Create a .env file in the root directory:

# Database Configuration
DB_HOST=localhost
DB_PORT=5432
DB_USERNAME=your_username
DB_PASSWORD=your_password
DB_NAME=resume_builder

# JWT Configuration
JWT_SECRET=your-super-secret-jwt-key
JWT_EXPIRES_IN=1h

# Application
PORT=3000
NODE_ENV=development

# AI Service (if applicable)
AI_API_KEY=your-ai-api-key
AI_SERVICE_URL=https://your-ai-service.com/api

Development

Running the Application

# Development mode with hot reload
npm run start:dev

# Production mode
npm run start:prod

API Documentation

Swagger Integration

Access API documentation at: http://localhost:3000/api-docs