Prerequisite
- 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
- If you do not have installed Node.js in your machine then go to this link in order to install node.
How to use
- Clone this repository.
git clone https://github.com/salomonelli/best-resume-ever.git
-
Go to the cloned directory (e.g.
cd best-resume-ever). -
Run
npm install. -
Customize your resume in the
resume/directory: edit your datadata.ymland replace the default profile-pictureid.jpgwith your picture. Rename your picture asid.jpgand copy it in theresume/directory. -
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.
- Export your resume as pdf by running the command
npm run export. In order to avoid errors due to the concurrency of twonpm runcommands, stop the execution of the previusnpm run devand 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.
Credits
This project uses several open source packages:
- Vue
- Puppeteer
- LESS
sarasteiert.com ·
GitHub @salomonelli ·
Twitter @salomonelli