best-resume-ever README

The project's README from github.com/salomonelli/best-resume-ever. As one markdown file: README.md.


Markdownify
best-resume-ever

Travis badge

:necktie: :briefcase: Build fast :rocket: and easy multiple beautiful resumes and create your best CV ever!

Made with Vue and LESS.



Cool

Creative

Green

Purple

Side Bar

Left Right

Material Dark

Oblique



Prerequisite

  1. It is required to have Node.js with version 8.5.0 or higher. To see what version of Node.js is installed on your machine type the following command in the terminal:
node -v
  1. If you do not have installed Node.js in your machine then go to this link in order to install node.

How to use

  1. Clone this repository.
git clone https://github.com/salomonelli/best-resume-ever.git

  1. Go to the cloned directory (e.g. cd best-resume-ever).

  2. Run npm install. This may take a few seconds.

  3. Customize your resume in the resume/ directory: edit your data data.yml and replace the default profile-picture id.jpg with your picture. Rename your picture as id.jpg and copy it in the resume/ directory. During this step, you may find it easier to navigate with Finder or File Explorer to get to the files. This will allow you to edit files with your computers default text editor.

  4. Preview resumes with npm run dev. The command will start a server instance and listen on port 8080. Open (http://localhost:8080/home) in your browser. The page will show some resume previews. To see the preview of your resume, with your picture and data, click on one layout that you like and the resume will be opened in the same window.

Resume previews

  1. Export your resume as pdf by running the command npm run export. In order to avoid errors due to the concurrency of two npm run commands, stop the execution of the previus npm run dev and then type the export command.

All resumes will be exported to the pdf/ folder.


Creating and Updating Templates

Please read the developer docs on how to create or update templates.


Contribute

Feel free to add your own templates, language supports, fix bugs or improve the docs. Any kind of help is appreciated! If you make any kind of changes to an existing template, please commit them as new templates.


Sponsored by

Sponsored by RxDB - NodeJs Database

The NodeJs Database

Credits

This project uses several open source packages:


sarasteiert.com  ·  GitHub @salomonelli  ·  Twitter @salomonelli

License

MIT

best-resume-ever (salomonelli/best-resume-ever)

Searching Database…

16.5K ·GitHub
Best-resume-ever
What is this?A resume builder: describe your CV once in a data file and get multiple beautifully designed resumes you can preview in the browser and export as PDF. Built with Vue and LESS.
Is this a website I visit or something I run myself?Something you run yourself: it is a local Node.js app. You clone it, start a dev server with 'npm run dev' and use it in your browser at localhost:8080.
How do I get it running?Clone the repository, cd into it and run 'npm install', then start 'npm run dev' — the page on port 8080 shows previews of every layout, and clicking one opens the resume in the same window.
What do I need installed on my machine first?Node.js is the only prerequisite: the README asks for version 8.5.0 or higher, and the package metadata now requires Node 18+ with npm 6+.
Can I export the PDF while the preview server is still running?No — stop 'npm run dev' first. Running 'npm run export' while the dev server is active causes errors because the two npm commands run concurrently.
Where do I enter my own details and photo?Everything lives in the resume/ directory: edit data.yml with your information and copy your picture there renamed to id.jpg, replacing the default profile picture.
Which layouts can I pick from?The README showcases designs like Cool, Creative, Green, Purple, Side Bar (left and right), Material, Dark and Oblique — you click a layout in the browser to preview it.
How does it turn my resume into a PDF file?The export runs on Puppeteer, a headless Chrome automation library, and writes all finished resumes into the pdf/ folder.
Can I design my own template?Yes — developer docs explain creating and updating templates. If you change an existing one, the project asks you to commit your edits as a new template instead.
What are similar projects?rendercv, Resume-Matcher, Awesome-CV, ASu-resume-skills, fe-interview, resume.github.com, ai-job-search, dossier
Which topics is it in?resume-builder, cv, resume, job-search, material-design, design, pdf, vue, css, web-app, productivity, gui
Creator
salomonelli
Size
117.4 MB
Stars
16.5K
Updated
CommitFeb 15
Age
9y
Commits · 90 Days