@teemoai/resume-builder

A modern React component library for building professional resumes with real-time preview and PDF export capabilities.

Features

• 🚀 Real-time resume preview
• 📄 PDF export functionality
• 🎨 Customizable templates
• 📱 Responsive design
• ⚡ Built with React 18+ and TypeScript
• 🎨 Styled with Tailwind CSS

Installation

npm install @teemoai/resume-builder
# or
yarn add @teemoai/resume-builder

Peer Dependencies

This package requires the following peer dependencies:

{
  "react": ">=16.8.0",
  "react-dom": ">=16.8.0",
  "react-router-dom": ">=6.0.0",
  "@reduxjs/toolkit": ">=1.0.0",
  "react-redux": ">=7.0.0"
}

Usage

Basic Usage

import { CreateResume } from '@teemoai/resume-builder';
import '@teemoai/resume-builder/styles';

function App() {
  return (
    <div className="min-h-screen bg-gray-50">
      <CreateResume />
    </div>
  );
}

export default App;

With Redux Provider

import { Provider } from 'react-redux';
import { store, CreateResume } from '@teemoai/resume-builder';
import '@teemoai/resume-builder/styles';

function App() {
  return (
    <Provider store={store}>
      <div className="min-h-screen bg-gray-50">
        <CreateResume />
      </div>
    </Provider>
  );
}

export default App;

With Custom Router

import { BrowserRouter, Routes, Route } from 'react-router-dom';
import { ImportResume, CreateResume } from '@teemoai/resume-builder';
import '@teemoai/resume-builder/styles';

function App() {
  return (
    <BrowserRouter>
      <Routes>
        <Route path="/" element={<ImportResume />} />
        <Route path="/create" element={<CreateResume />} />
      </Routes>
    </BrowserRouter>
  );
}

export default App;

Components

CreateResume

The main component that renders the resume builder interface.

ImportResume

A component that allows users to import existing resumes.

Styling

This package uses Tailwind CSS for styling. Make sure to include Tailwind CSS in your project.

Development

1. Clone the repository
2. Install dependencies: npm install
3. Start development server: npm run dev
4. Build for production: npm run build

License

MIT © Teemo AI