Application Requirements/Schema

The profileSchema defines the structure that every job profile must follow, and described optional and required fields. It includes information such as full name, email, phone number, resume filename, and other key details for generating solid applications.

Application Schema

The profile model must adhere to the following structure:

Properties

  • Name
    name
    Type
    string
    Description

    Full name.

  • Name
    email
    Type
    string
    Description

    Email.

  • Name
    phone
    Type
    string
    Description

    Phone number (123)-456-7890.

  • Name
    address
    Type
    string
    Description

    Address.

  • Name
    portfolio
    Type
    string
    Description

    Portfolio website link. Can be null/undefined.

  • Name
    filename
    Type
    string
    Description

    Name of resume file.

  • Name
    resumeLink
    Type
    string
    Description

    Link to resume file (must be pdf, txt, or docx).

  • Name
    keyInfo
    Type
    string
    Description

    Key information (for AI prompting).

  • Name
    linkedin
    Type
    string
    Description

    LinkedIn handle. Can be null/undefined.

  • Name
    github
    Type
    string
    Description

    Github handle. Can be null/undefined.

  • Name
    twitter
    Type
    string
    Description

    Twitter handle. Can be null/undefined.

  • Name
    figma
    Type
    string
    Description

    Figma username. Can be null/undefined.

  • Name
    dribbble
    Type
    string
    Description

    Dribbble handle. Can be null/undefined.

  • Name
    stackoverflow
    Type
    string
    Description

    Stackoverflow username. Can be null/undefined.

Example Code Snippet

Below is an example of how to structure a job application using the profileSchema:

const demoProfile = {
  name: 'John Doe',
  email: 'test@example.com',
  phone: '(123)-456-7890',
  address: '100 Example Lane, City, CA',
  filename: 'resume.pdf',
  keyInfo: 'I am good at coding.',
  linkedin: 'example',
};

Was this page helpful?