Skip to content

Latest commit

 

History

History
138 lines (96 loc) · 4.65 KB

README.md

File metadata and controls

138 lines (96 loc) · 4.65 KB
Raw

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.

Why yet another tool?

Most of the available tools are either :

  • institutional (they will not be able to serve all application purposes)
  • dev-oriented (they will not be able to serve most domain applications)
  • social networks (companies still expect an attachment in the applications, not just an online profile)
  • needing payments (we believe this service should be free)
  • needing registration (we believe this service should not)
  • attached to a job marketplace
  • not customizable enough (they will not help you stand out from other applicants)
  • hard to properly customizable (they will not be able to prevent broken design and inconsistencies)
  • needing too many actions (they will not access preview after several question answerings and form fillings)

So far, tools we believe are best out there are :

...but they all fall into one of the points above. With Nice Resume, we try to provide a fast and easy, direct-preview, fully-customizable, template-helped, free and registrationless experience that will serve all kinds of applications.

Here is a more comprehensive list of tools

Technical

Resources

Prerequisites

Project setup

nvm use
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. Add the name in the template union type in /types
  2. Add the name in the templates array in /globals
  3. Add the base settings in the templateBaseSettings object in /globals and override them in the templateSettings object

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 from other tools:

  • Elegant is the theme from JSON Resume by Mudassir Ali
  • Kendall is the theme from JSON Resume by Adam Kendall
  • 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/piksail/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