Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #429

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #429

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,34 +65,34 @@

## 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:
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, open the terminal on your computer as an Admin by right clicking and selecting Run As Administrator, then 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](https://nodejs.org/en/download/) in order to install node.
2. If you do not have Node.js installed in your machine then go to [this link](https://nodejs.org/en/download/) in order to install node. Download the Current or LTS 64-bit version of Node.js. During the Node.js installation, use the option to install additional packages. If you see errors during the Node.js installation, please ignore them. Once Node.js is isntalled, restart your terminal as an administrator and type node-v again to check your Node.js version.

## How to use

1. Clone this repository.
1. Clone this repository. (Make sure you have the cloned repository on a local location and not a network location as terminal access will be more deifficult.)

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

2. Go to the cloned directory (e.g. `cd best-resume-ever`).
2. Using the terminal, navigate to the location of the cloned best-resume-ever repository on your computer. (e.g. `cd best-resume-ever`). If you need assistance with navigating through a terminal, here is a tutorial: [Link](https://www.lifewire.com/change-directories-in-command-prompt-5185508)

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.
4. Customize your resume in the `resume/` directory: edit your data in `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. (notepad, sublime, notepad++, visual studio code, etc.)

5. 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.
5. Preview resumes by typing `npm run dev` in the terminal (Remember to have navigated to the best-resume-ever directory) . 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. If you see errors or warnings during NPM Run Dev then please ignore them. It may take a while and not look like it’s progressing but please wait for the input prompt to be present again. This can take several minutes.

![Resume previews](/readme-images/resumePreviews.png)


6. 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.
6. Export your resume as a 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 typing Ctrl+C on your keyboard and then type the `npm run export` command.

All resumes will be exported to the `pdf/` folder.

Expand Down