Skip to main content

Overview

The Resume interface is the top-level type that defines the complete structure of a resume in Wrkks. It aggregates all resume sections including personal information, experience, education, and custom sections.

Type definition

export interface Resume {
  personalInfo: PersonalInfo;
  summary: string;
  skills: Skills;
  experience: Experience[];
  projects: Project[];
  education: Education[];
  extracurricular: string[];
  customSections: CustomSection[];
}

Properties

personalInfo
PersonalInfo
required
Personal information including name, contact details, and social links. See PersonalInfo for details.
summary
string
required
A brief professional summary or objective statement that appears at the top of the resume.
skills
Skills
required
Technical and soft skills organized into categories. See Skills for details.
experience
Experience[]
required
Array of work experience entries. See Experience for details.
projects
Project[]
required
Array of project entries showcasing work and accomplishments. See Project for details.
education
Education[]
required
Array of educational background entries. See Education for details.
extracurricular
string[]
required
Array of extracurricular activities, volunteer work, or other relevant involvements.
customSections
CustomSection[]
required
Flexible sections for additional content like certifications, languages, awards, etc. See CustomSection for details.

Example

{
  "personalInfo": {
    "name": "Jane Smith",
    "title": "Full Stack Developer",
    "location": "San Francisco, CA",
    "phone": "+1 (555) 123-4567",
    "email": "[email protected]",
    "website": "https://janesmith.dev",
    "linkedin": "https://linkedin.com/in/janesmith",
    "github": "https://github.com/janesmith",
    "twitter": "https://twitter.com/janesmith",
    "imageUrl": "https://example.com/profile.jpg"
  },
  "summary": "Experienced full stack developer with 5+ years building scalable web applications.",
  "skills": {
    "languages": ["TypeScript", "Python", "Go"],
    "frameworksAndTools": ["React", "Node.js", "Docker"],
    "softSkills": ["Team Leadership", "Agile Development"]
  },
  "experience": [],
  "projects": [],
  "education": [],
  "extracurricular": [
    "Volunteer coding instructor at local community center",
    "Organizer of monthly JavaScript meetup"
  ],
  "customSections": [
    {
      "title": "Certifications",
      "items": ["AWS Certified Solutions Architect", "Google Cloud Professional"]
    }
  ]
}

Usage

The Resume type is used throughout the application:
  • As the shape for resume data in components
  • For validation when importing or editing resume data
  • As the return type for resume data fetching functions
  • In resume rendering and export functionality

Build docs developers (and LLMs) love