Skip to content

Latest commit

 

History

History
129 lines (92 loc) · 5.25 KB

README.md

File metadata and controls

129 lines (92 loc) · 5.25 KB
Raw


Markdownify
best-resume-ever

Travis badge

👔 💼 Build fast 🚀 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.


Credits

This project uses several open source packages:


sarasteiert.com  ·  GitHub @salomonelli  ·  Twitter @salomonelli

License

MIT