Skip to content
This repository has been archived by the owner on Oct 10, 2024. It is now read-only.

Benjent/nice-resume

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Nice Resume

GitHub last commit GitHub CI

GitHub Pages badge Nuxt badge Tailwind CSS badge Conventional commits badge ESLint badge

Edit your resume and your cover letter, choose a nice template and save your work for the next time.

This is a Nuxt project bootstrapped with Nuxi.

See it live.

Resources

Prerequisites

Project setup

corepack enable pnpm
pnpm install

Compile and Hot-Reload for Development

pnpm run dev

Compile and Minify for Production

# Preview production build
pnpm run build
pnpm run preview

Tests

https://nuxt.com/docs/getting-started/testing

pnpm run test:unit

Playwright end-to-end

# Create and configure `./test/.env` based on `./test/default.env` if needed
pnpm run test:playwright

Test recording generation with Playwright

Add a template

  1. Create the Vue component in /templates
  2. Add the name in the template union type in /types
  3. Add the name in the templates array in /globals
  4. Add the name in the templateMapper in /components/Preview.vue

Make sure the above steps rely on the same template name.

Use a template

Templates offer an aside section on the left and a main section on the right that can be split into two columns. Select Aside, Full or Half to place content accordingly.

Some themes come other tools:

  • Macchiato is the theme from JSON Resume by Alessandro Biondi
  • OpenResume is the theme from OpenResume
  • Paper is adapted from the One Page Plus theme from JSON Resume

Docker

# Pull and run
docker run \
    --rm \
    -p 3000:3000 \
    ghcr.io/benjent/nice-resume:latest

# Build and run
docker build -t nice-resume:local .
docker run \
    --rm \
    -p 3000:3000 \
    nice-resume:local

Troubleshooting

FATAL ERROR: Ineffective mark-compacts near heap limit Allocation failed - JavaScript heap out of memory
  • Delete .nuxt and /tmp/nitro
  • Increase memory in .pnpmrc

Releases

No releases published

Packages

No packages published

Languages