Cool

Creative

Green

Purple

Side Bar

Left Right

Material Dark

Oblique

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

2. If you do not have installed Node.js in your machine then go to this link in order to install node.

1. Clone this repository.

git clone https://github.com/salomonelli/best-resume-ever.git

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

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

4. 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.

5. Preview resumes with npm run dev. The command will start a server instance and listen on port 8080. Open (http:https://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.

6. Do this step if you want to create a PDF resume, if not, skip this step. This software has experienced issues running on newer node.js versions such as 16.18.0 when trying use the npm run export for creating a pdf for the resumes. Node 12.0.0 has been tested and works well for this software. You will need Node Version Manager (nvm) to install and switch back to an earlier version. NVM allows you to very easily download, install, switch and manage multiple versions of nodejs. If you dont have nvm, you can obtain it by following this command: curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.34.0/install.sh | bash1 You can now download and install node v12 using this command: nvm install 12.0.0 If you want to switch back to your newer version you can use the command nvm use <version>

7. 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 by pressing Ctrl + c and then type the export command.

All resumes will be exported to the pdf/ folder.

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

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.

This project uses several open source packages:

• Vue
• Puppeteer
• LESS

sarasteiert.com  ·  GitHub @salomonelli  ·  Twitter @salomonelli

MIT