Skip to content

Repository files navigation

CV-brew

CV-brew is a Next.js application (app router) for generating CVs. It provides a small web UI and a server API endpoint to create or export CVs programmatically. The project uses modern Next.js (app directory), React, TypeScript, and Tailwind-related tooling.

This README explains how to run the project locally, build for production, and use the provided API.

Features

  • App directory (Next.js) with server and client components
  • API route for generating CVs: app/api/generate-cv/route.ts
  • TypeScript-ready

Tech stack

  • Next.js 16 (app router)
  • React 19
  • TypeScript
  • Tailwind-related tooling (postcss, tailwind)
  • node-latex (installed) for LaTeX-based exports (see code)

Requirements

  • Node.js (version compatible with Next.js 16 and React 19)
  • npm, pnpm, or yarn

Setup

Clone the repo and install dependencies:

git clone <repo-url> ./cvbrew; Set-Location .\cvbrew; npm install

Run the development server:

npm run dev

Open http://localhost:3000 in your browser.

Available scripts

From package.json:

  • npm run dev — start development server (next dev)
  • npm run build — build for production (next build)
  • npm run start — start production server after build (next start)
  • npm run lint — run ESLint

API: generate CV

An API route exists at /api/generate-cv (server route) — see app/api/generate-cv/route.ts.

You can POST a payload to that route (check the route implementation for expected JSON shape). Example using curl:

curl -X POST "http://localhost:3000/api/generate-cv" -H "Content-Type: application/json" -d '{"name":"Jane Doe"}'

Adjust the body to match the route's expected input (inspect the source to confirm fields and behavior).

Notes and next steps

  • This project uses a newer Next.js version with potential breaking changes from older examples — check node_modules/next/dist/docs/ or the Next.js docs bundled with this version if you need to understand routing/edge behavior.
  • If you plan to generate PDFs via LaTeX or other tools, ensure required system packages (LaTeX) are available on your machine or CI environment.

Contributing

Contributions are welcome. Open issues or PRs for bug fixes and features.

License

Specify a license for your project if desired (e.g., MIT).

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages