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…

这是什么?一个简历生成工具:在数据文件里描述一次你的简历内容,就能得到多份设计精美的简历,可以在浏览器里预览并导出为 PDF。基于 Vue 和 LESS 开发。
这是一个我访问的网站,还是需要我自己运行的程序?需要你自己运行:它是一个本地的 Node.js 应用。你把它克隆下来,用 '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' 会报错,因为这两个 npm 命令会同时运行。
我在哪里填写自己的信息和照片?所有内容都在 resume/ 目录里:把你的信息填进 data.yml,再把你的照片复制到该目录并重命名为 id.jpg,替换默认的头像。
有哪些布局可以选?README 展示了 Cool、Creative、Green、Purple、Side Bar(左右两款)、Material、Dark 和 Oblique 等设计——你在浏览器里点击某个布局就能预览。
它是怎么把我的简历变成 PDF 文件的?导出基于 Puppeteer(一个无头 Chrome 自动化库),并把所有生成好的简历写入 pdf/ 文件夹。
我可以自己设计模板吗?可以——开发者文档介绍了如何创建和更新模板。如果你修改的是现有模板,项目希望你把修改作为新模板提交,而不是直接改动原模板。
Size
117.4 MB
Stars
16.5K
Updated
CommitFeb 15
Age
9y
Commits · 90 Days