CV Builder

Live Demo

A robust and mobile-friendly React application that allows users to create professional CVs (Resumes) using a clean template and export them as PDF files.

Features

• Real-time Preview: See your changes instantly as you type.
• PDF Export: Download your CV as a high-quality PDF document.
• Mobile Friendly: Fully responsive design that works on desktops, tablets, and mobile phones.
• Data Validation: Ensures essential fields are filled before generating the PDF.
• Example Data: Load example data to see how the CV looks with content.
• Customizable: Add or remove experience and education sections as needed.
• Desktop App: Run as a standalone desktop application on Windows, macOS, and Linux.

Prerequisites

Before you begin, ensure you have the following installed on your machine:

• Node.js (v14.0.0 or higher)
• npm (usually comes with Node.js)

Installation

1. Clone the repository

   git clone https://github.com/wikicrafter/cvbuilder.git
   cd cvbuilder

2. Install dependencies

   npm install

Usage

1. Start the development server

   npm start

   This will run the app in development mode. Open http://localhost:3000 to view it in your browser.

2. Build for production

   npm run build

   Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

3. Run as Desktop App

   npm run electron:dev

   This will launch the application in a standalone Electron window.

4. Build Desktop App

   npm run electron:build

   This will build the React app and then package it as a desktop application installer (e.g., .exe, .dmg) in the dist folder.

Windows Release

• Pre-release portable .exe: Download CV BuilderX 0.1.0

Testing

The application includes a suite of automated tests to ensure reliability.

1. Run tests

   npm test

   This launches the test runner in the interactive watch mode.

Project Structure

• src/components: Contains all React components.
  • CVForm: Components for the input form.
  • CVPreview: Components for the CV preview and print layout.
  • Utils: Utility components like Buttons, Inputs, and ErrorBoundary.
• src/theme: Styled-components theme configuration.

Technologies Used

• React - UI Library
• styled-components - Styling
• react-to-print - PDF Generation
• uuid - Unique ID generation
• prop-types - Type checking
• Electron - Desktop Application Framework