Skip to content

ResuGen is a modern, intuitive, and ATS-friendly resume generator built with Nuxt 3 and Nuxt UI. Create personalized resumes with real-time preview, flexible customization, and seamless PDF export.

License

Notifications You must be signed in to change notification settings

LeeKrane/ResuGen

Repository files navigation

ResuGen

A modern, intuitive, and open-source resume generator designed to help you create ATS-friendly professional resumes with ease. Built with Nuxt 3 and Nuxt UI.

Marketing Banner Placeholder

🌟 Features

  • Modern UI/UX: Clean, responsive interface built with Nuxt UI components
  • Real-time Preview: See changes instantly as you build your resume
  • ATS-Friendly: Optimized for Applicant Tracking Systems
  • Browser-based PDF Export: Print to PDF directly through your browser
  • Data Portability: Import/Export your resume data as ZIP
  • Flexible Customization: Personalize colors, spacing, and typography
  • Type-Safe: Built with TypeScript for reliability
  • Aesthetic Design: Subtle particle animation background

🎯 How It Works

  1. Fill Your Details: Enter your information using our intuitive form-based editor
  2. Customize Appearance: Adjust colors, spacing, and typography to match your style
  3. Generate PDF: Use your browser's print function to save as PDF
    • Click the "Print" button
    • Select "Save as PDF" in your browser's print dialog
    • Choose your preferred paper size (A4 recommended)
    • Save your professional resume

🚀 Quick Start

Prerequisites

  • Node.js 18 or higher
  • pnpm (recommended) or npm/yarn/bun

Installation

  1. Clone the repository:

    git clone https://github.com/LeeKrane/ResuGen.git
    cd ResuGen
  2. Install dependencies:

    pnpm install
  3. Start the development server:

    pnpm dev
  4. Open http://localhost:3000 in your browser

🛠️ Tech Stack

  • Framework: Nuxt 3 - Vue.js Framework
  • UI Components: Nuxt UI - Ready-to-use Vue components
  • Styling: Tailwind CSS - Utility-first CSS framework
  • Type Safety: TypeScript - Static type checking
  • File Handling: JSZip - Resume data import/export
  • Visual Effects: Nuxt Particles - Decorative background
  • Image Optimization: Nuxt Image - Automatic image optimization

📁 Project Structure

resugen/
├── app/
│   ├── components/
│   │   ├── form/       # Form-related components
│   │   ├── general/    # General-purpose components
│   │   └── site/       # Site layout components
│   └── pages/          # Application routes
├── public/             # Static assets
├── types/              # TypeScript type definitions
└── nuxt.config.ts      # Nuxt configuration

🔧 Configuration

The application can be configured through nuxt.config.ts:

export default defineNuxtConfig({
  // Enable development tools
  devtools: { enabled: true },

  // Configure modules
  modules: [
    '@nuxt/ui',
    '@nuxt/image',
    'nuxt-particles'
  ],

  // Additional configuration...
})

🎨 Customization Options

  • Colors: Customize all aspects of your resume's color scheme
  • Typography: Choose from various font combinations
  • Spacing: Adjust margins, padding, and layout spacing
  • Sections: Add, remove, or reorder resume sections
  • Content: Full control over text formatting and structure

📋 Project Management

We use Volta for project management and issue tracking. Volta is a web application built on top of the GitHub API that provides a real-time and intuitive interface with an automated issue board out of the box. It helps reduce the overwhelming flow of notifications to focus on what matters most. Check out our Volta board.

🤝 Contributing

We welcome contributions! Please see our Contributing Guidelines for details on:

  • Code style and conventions
  • Development workflow
  • Issue reporting
  • Pull request process

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🌐 Links

✨ Acknowledgments

📧 Support

Need help? Have questions?


ResuGen Logo

Made with ❤️ by Krane Development

About

ResuGen is a modern, intuitive, and ATS-friendly resume generator built with Nuxt 3 and Nuxt UI. Create personalized resumes with real-time preview, flexible customization, and seamless PDF export.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages