resume/README.md
2017-02-22 21:47:07 +01:00

59 lines
1.8 KiB
Markdown
Executable File

# best-resume-ever
Build your best resume ever!
A collection of multiple beautiful resumes build with LESS and Mustache Templates. Choose your favorite Curriculum Vitae and easily export it as PDF.
## Resumes
<a href="public/preview/resume-left-right.png"><img src="public/preview/resume-left-right.png" width="150"/></a>
<a href="public/preview/resume-side-bar.png"><img src="public/preview/resume-side-bar.png" width="150"/></a>
<a href="public/preview/resume-oblique.png"><img src="public/preview/resume-oblique.png" width="150"/></a>
<a href="public/preview/resume-grey-boxes.png"><img src="public/preview/resume-grey-boxes.png" width="150"/></a>
<a href="public/preview/resume-spotify.png"><img src="public/preview/resume-spotify.png" width="150"/></a>
## Getting Started
Follow these instructions to set up this project and create your own CV.
### Prerequisites
To run this project, please install node. (See https://nodejs.org/en/download/package-manager/ and https://nodejs.org/en/download/)
### Installation
- Clone this repository.
- Switch to project directory and run `npm install`.
### Adjusting your personal information
- Adjust your personal information in `/src/person.js`.
- Replace placeholder image `/public/person.jpg` with your portrait.
- To preview your CV run `npm run dev`. Check out <http://localhost:3000>.
The app recompiles automatically. This may take a short while. Feel free to adjust stylings to fit your needs!
### Exporting resumes as PDF
With `npm run pdf` the resumes can be exported. You will find all resumes as PDFs in `/pdf`.
## Configuration and Contribution
Please read [the guide](/docs/Docs.md) on how to configure page size, stylings and adding your own templates.
Feel free to create your own templates or help in fixing issues. To find out how to add your own templates!