MCPcopy Index your code
hub / github.com/alcpereira/cv-generator

github.com/alcpereira/cv-generator @main

Chat with this repo
repository ↗ · DeepWiki ↗ · + Follow
17 symbols 33 edges 17 files 0 documented · 0%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

CV PDF Generator

The CV PDF Generator is a React app used to build a CV and export it as a PDF.

Prerequisites

Make sure you have the correct version of Node.js installed. You can use a node version manager that supports .node-version file such fnm.

This project uses pnpm as the package manager, managed via Corepack. Corepack comes bundled with recent Node.js versions and ensures everyone uses the same pnpm version as specified in package.json.

If you haven't already, enable Corepack:

corepack enable

You do not need to install pnpm globally. Corepack will automatically use the correct version.

How To Run

  1. Add your picture in src/assets/profile.jpeg
  2. Fill out your information in data.json
  3. Adapt CSS or scale in pdf.ts if needed
  4. Run the following commands in the terminal
pnpm install

pnpm pdf

Development / Debug

If you want to tweak your CV or debug some features you are implementing, you can the dev server using:

pnpm dev

Built With

  • React + Vite
  • Puppeteer for PDF generation

Contributing: Here's a quick guide for writing commit messages:

  1. Start with a type: Use fix:, feat:, docs:, etc., to indicate the nature of the change.
  2. Add a brief description: Follow the type with a concise summary of the change (2-4 words).
  3. Optional details: Use a blank line to separate the summary from a longer description if needed.
  4. Reference issues: Include issue numbers or tags if applicable
  5. Explore conventional commits documentation here: https://kapeli.com/cheat_sheets/Conventional_Commits.docset/Contents/Resources/Documents/index

Core symbols most depended-on inside this repo

Shape

Function 17

Languages

TypeScript100%

Modules by API surface

src/components/Profile/Profile.tsx4 symbols
src/components/Category/Category.tsx3 symbols
src/hooks/useProfilePicture.ts2 symbols
src/components/Title/Title.tsx1 symbols
src/components/Separator/Separator.tsx1 symbols
src/components/Profile/ProfileLink/ProfileLink.tsx1 symbols
src/components/Profile/ProfileLanguages/ProfileLanguages.tsx1 symbols
src/components/Profile/ProfileImage/ProfileImage.tsx1 symbols
src/components/Header/Header.tsx1 symbols
src/components/Bubble/Bubble.tsx1 symbols
src/App.tsx1 symbols

For agents

$ claude mcp add cv-generator \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page