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…

Что это такое?Конструктор резюме: вы один раз описываете своё CV в файле с данными и получаете несколько красиво оформленных резюме, которые можно посмотреть в браузере и экспортировать в PDF. Сделано на Vue и LESS.
Это сайт, куда я захожу, или программа, которую я запускаю сам?Программа, которую вы запускаете сами: это локальное приложение на Node.js. Вы клонируете его, запускаете dev-сервер командой 'npm run dev' и работаете с ним в браузере по адресу localhost:8080.
Как его запустить?Склонируйте репозиторий, перейдите в него командой cd и выполните 'npm install', затем запустите 'npm run dev' — на странице по порту 8080 будут превью всех макетов, а клик по макету откроет резюме в том же окне.
Что должно быть установлено на моём компьютере заранее?Единственное требование — Node.js: в README указана версия 8.5.0 или выше, а в метаданных пакета сейчас требуется Node 18+ с npm 6+.
Могу ли я экспортировать PDF, пока сервер предпросмотра ещё работает?Нет — сначала остановите 'npm run dev'. Если запустить 'npm run export' при работающем dev-сервере, возникнут ошибки, потому что две команды npm выполняются одновременно.
Куда вписать свои данные и фото?Всё находится в каталоге resume/: отредактируйте файл data.yml, внеся туда свою информацию, и скопируйте туда свою фотографию под именем id.jpg, заменив стандартное фото профиля.
Какие макеты можно выбрать?В README показаны дизайны вроде Cool, Creative, Green, Purple, Side Bar (слева и справа), Material, Dark и Oblique — вы кликаете по макету в браузере, чтобы посмотреть, как он выглядит.
Как из моего резюме получается PDF-файл?Экспорт работает на Puppeteer — библиотеке для автоматизации headless Chrome — и сохраняет все готовые резюме в папку pdf/.
Могу ли я сделать свой собственный шаблон?Да — в документации для разработчиков описано создание и обновление шаблонов. Если вы меняете существующий, проект просит оформить ваши правки как новый шаблон.
Size
117.4 MB
Stars
16.5K
Updated
CommitFeb 15
Age
9y
Commits · 90 Days