File structure

To generate a resume you need to create a JSON file with a specific structure. Below you can see a Typescript like definition of it. You can also use this file as an example.

type Resume = {
  name: string
  summary: string
  employments: Employment[]
  index?: boolean // Do you want your resume to be indexed by search engines? Default: false
  image?: string
  location?: Location
  trainings?: Training[]
  sideProjects?: Project[]
  technologies?: Technology[]
}

type Employment = {
  employer: Employer
  period: Period
  summary: string
  roles: Role[]
}

type Training = {
  institution: Institution
  period: Period
  summary: string
}

type Project = {
  name: string
  website: string
  online: boolean
  period: Period
  summary: string
}

type Technology = {
  name: string
  website: string
  recentlyUsed: boolean
  canMentor: boolean
  knowledgeOfBestPractices: 'low' | 'medium' | 'high'
  knowledgeOfFeatures: 'low' | 'medium' | 'high'
  taskComplexity: 'easy' | 'intermediate' | 'hard'
}

type Employer = {
  name: string
  website: string
}

type Period = {
  from: string
  to: string | null
}

type Role = {
  title: string
  summary: string
  majorAchievements: Achievement[]
}

type Achievement = {
  title: string
  summary: string
  technologies?: string[]
}

type Institution = {
  name: string
  website: string
}

type Location = {
  city: string
  state?: string
  country: string
}