1.5.2 โ€ข Published 4 months ago

faux-cv v1.5.2

Weekly downloads
-
License
MIT
Repository
-
Last release
4 months ago

Faux-CV

npm version GitHub Workflow Status GitHub stars License: MIT Downloads Build Status Coverage Status

Generate realistic fake resumes for testing and development. Customizable by industry, experience level, and output format.

logo

๐Ÿš€ Features

  • โœจ Realistic content - Professionally written work experience, skills, education, and certifications
  • ๐Ÿข Multiple industries - Specialized profiles for tech, finance, healthcare, marketing, and education sectors
  • ๐Ÿ“Š Experience levels - Generate junior, mid-level, or senior professional profiles
  • ๐Ÿ“„ Multiple formats - Output in Markdown, JSON, PDF, or all formats
  • ๐ŸŽจ Customizable templates - Use built-in styles or create your own with Mustache templating
  • ๐Ÿ‘ฅ Batch generation - Create multiple resumes with a single command
  • ๐Ÿ”„ Reproducible output - Set random seeds for consistent results

๐Ÿ“ฆ Installation

Install globally:

npm install -g faux-cv

Or use directly with npx:

npx faux-cv

PDF Support

To use the PDF generation feature, install the optional dependencies:

npm install puppeteer showdown

๐Ÿ› ๏ธ Usage

Command Line

npx faux-cv --industry tech --experience 7 --format both

Options

OptionAliasDescriptionDefault
--industry <industry>-iIndustry specializationtech
--experience <years>-eYears of experience5
--format <format>-fOutput format (markdown, json, pdf, both)both
--gender <gender>-gGender (male, female)Random
--output <filename>-oOutput file name (without extension)Person's name
--no-linkedin-lExclude LinkedIn profileLinkedIn included
--no-website-wExclude personal websiteWebsite random
--template <filepath>-tCustom Mustache template fileDefault template
--count <number>-cNumber of resumes to generate1
--seed <value>-sRandom seed for consistent generationRandom
--pdf-style <style>-pPDF style (default, modern, minimal, professional)default
--pdf-color <color>Primary color for PDF (hex code)#0066cc
--batch-pdf-bCreate a single PDF containing all resumesfalse

Available Industries

  • Tech: Software Engineering, IT, Data Science
  • Finance: Banking, Investment, Accounting
  • Healthcare: Medical, Health Services
  • Marketing: Digital Marketing, Content, Branding
  • Education: Teaching, Educational Administration

Examples

Generate a tech resume with 3 years of experience:

npx faux-cv -i tech -e 3

Generate 5 healthcare resumes with 10+ years of experience:

npx faux-cv -i healthcare -e 12 -c 5

Generate a finance resume in JSON format only:

npx faux-cv -i finance -f json

Generate a professional PDF resume with custom styling:

npx faux-cv -f pdf -p professional --pdf-color "#336699"

Generate multiple resumes in a single batch PDF file:

npx faux-cv -c 5 -f pdf -b -i marketing

Use a custom template:

npx faux-cv -t ./my-template.mustache

๐Ÿ“š Programmatic Usage

You can use faux-cv as a library in your Node.js projects:

const { generateResume } = require('faux-cv');

// Generate a resume with custom options
const resume = generateResume({
  industry: 'marketing',
  experienceYears: 6,
  format: 'both',
  gender: 'female',
  includeLinkedin: true,
  includeWebsite: true,
  pdfStyle: 'modern',
  pdfColor: '#2c3e50'
});

console.log(resume.markdown); // Markdown formatted resume
console.log(resume.json);     // Resume data as a JavaScript object

๐ŸŽจ Creating Custom Templates

Faux-CV uses Mustache templating. Create your own template files with the following variables:

Basic Information

  • {{name}}: Full name
  • {{contactInfo.email}}: Email address
  • {{contactInfo.phone}}: Phone number
  • {{contactInfo.location}}: Location (City, State)
  • {{contactInfo.linkedin}}: LinkedIn URL
  • {{contactInfo.website}}: Personal website URL
  • {{summary}}: Professional summary

Experience Section

Loop through {{#experience}} array:

  • {{position}}: Job title
  • {{company}}: Company name
  • {{startDate}}: Start date
  • {{endDate}}: End date
  • {{#bulletPoints}}: List of accomplishments

Education Section

Loop through {{#education}} array:

  • {{degree}}: Degree type
  • {{field}}: Field of study
  • {{institution}}: School name
  • {{graduationYear}}: Year of graduation
  • {{#details}}: Additional education details

Skills & Certifications

For skills (loop through {{#skillCategories}} array):

  • {{category}}: Skill category name
  • {{skills}}: List of skills in that category

For certifications (loop through {{#certifications}} array):

  • List of certification names

๐Ÿ“ Example Output

JSON Format

{
  "name": "Jordan Smith",
  "contactInfo": {
    "email": "jordan.smith@example.com",
    "phone": "555-123-4567",
    "location": "New York, NY",
    "linkedin": "linkedin.com/in/jordan-smith-456789",
    "website": "jordansmith.com"
  },
  "summary": "Experienced Software Engineer with 7 years of proven expertise in JavaScript, Python, and AWS...",
  "experience": [
    {
      "position": "Senior Developer",
      "company": "TechCorp",
      "startDate": "January 2020",
      "endDate": "Present",
      "bulletPoints": [
        "Led development of cloud infrastructure, resulting in 40% improvement in system performance",
        "Managed team of 5 engineers implementing microservices architecture"
      ]
    }
  ],
  "education": [
    {
      "degree": "Bachelor's",
      "field": "Computer Science",
      "institution": "State University",
      "graduationYear": 2016,
      "details": ["GPA: 3.8", "Dean's List"]
    }
  ],
  "skillCategories": [
    {
      "category": "Technical Skills",
      "skills": "JavaScript, Python, AWS, Docker, Kubernetes, React, Node.js"
    },
    {
      "category": "Soft Skills",
      "skills": "Team Leadership, Communication, Problem Solving"
    }
  ],
  "certifications": [
    "AWS Certified Solutions Architect",
    "Certified Kubernetes Administrator"
  ]
}

Markdown Format

# Jordan Smith

jordan.smith@example.com | 555-123-4567 | New York, NY | [LinkedIn](linkedin.com/in/jordan-smith-456789) | [Website](jordansmith.com)

## Summary
Experienced Software Engineer with 7 years of proven expertise in JavaScript, Python, and AWS...

## Experience
### Senior Developer | TechCorp | January 2020 - Present
- Led development of cloud infrastructure, resulting in 40% improvement in system performance
- Managed team of 5 engineers implementing microservices architecture

## Education
### Bachelor's in Computer Science | State University | 2016
- GPA: 3.8
- Dean's List

## Skills
### Technical Skills
JavaScript, Python, AWS, Docker, Kubernetes, React, Node.js

### Soft Skills
Team Leadership, Communication, Problem Solving

## Certifications
- AWS Certified Solutions Architect
- Certified Kubernetes Administrator

๐Ÿงช Testing

Run the test suite:

npm test

Run coverage report:

npm run test:coverage

๐Ÿค Contributing

Contributions, issues, and feature requests are welcome! Feel free to check issues page.

  1. Fork the project
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

๐Ÿ“„ License

This project is MIT licensed.

๐Ÿ™ Acknowledgements

1.5.2

4 months ago

1.5.1

4 months ago

1.5.0

4 months ago

1.4.0

4 months ago

1.3.0

4 months ago

1.2.0

4 months ago

1.1.0

4 months ago