Skip to content

TonyFred-code/project-cv-generator

Repository files navigation

Intelligent CV

Project Overview

Intelligent CV is a React-based application that allows users to input their information and generate a CV/résumé. This project serves as a foundation for creating intelligent CVs, with plans to incorporate AI for enhanced CV-building processes in the future. Users can also download the CV they create using the site.

Table of Contents

Features

  • Input sections for general information (name, email, phone number)
  • Sections for educational experience and practical experience
  • Editable CV sections with submit and edit buttons
  • CV download functionality
  • Responsive design to support desktop, tablet, and mobile views

Technologies Used

  • React: For building the user interface
  • Vite: For development and build processes
  • React-to-Print: For enabling CV download functionality
  • Material Design Icons (MDI): For using icons in the app
  • date-fns: For date handling and formatting
  • ESLint: For linting and code quality
  • dateformat: For formatting dates

Setup Instructions

To run the project locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/TonyFred-code/project-cv-generator.git
    
  2. Navigate to the project directory:

    cd intelligent-cv
    
  3. Install the dependencies:

    npm install
    
  4. Start the development server:

    npm run dev
    
  5. Build the project for production:

    npm run build
    
  6. Preview the production build:

    npm run preview
    

Build View

You can view the deployed application live on Vercel: Intelligent CV on Vercel

Credits

This project was inspired by the Intelligent CV app. Special thanks to the following resources for providing the tools and content that made this project possible:

  • The Odin Project: For the curriculum that guided the development of this project.
  • Material Design Icons: For the icon library used in the application. Icons can be found at Material Design Icons.
  • date-fns: For date formatting utilities.
  • React-to-Print: For the functionality to download the CV as a printable document.
  • Vercel: For hosting the application.

License

This project is licensed under the MIT License. See the LICENSE file for more details.