Skip to content

Latest commit

 

History

History
264 lines (227 loc) · 11.7 KB

README_V3.MD

File metadata and controls

264 lines (227 loc) · 11.7 KB
Raw

Resume Builder

Latest version here: resume-builder.js.org

Gotta find a job! Alright, let's make a new resume with this awesome template I found on Google, the problem is, this template might not be as awesome next month, or you might need to constantly add your new experience to the document. Gosh. Wouldn't be better to focus on adding new experiences in a raw format and let a automation process handle the layout? I agreed, and that's why Resume Builder is here.

You take care of the data and we take care of the template.

"Imagine you're an employer, and you have two resumes in front of you. One is filled wall-to-wall with text and uses four different fonts. It's also peppered with dozens of bolded, italicized, and underlined words and phrases. The second resume also offers a lot of information, but you can quickly scan the document because it makes good use of white space, features clear and consistent section headings, and uses bullets to make important items stand out. Which resume would you look at first?"

About

Resume Builder is a free open-source project that allows anyone to easily maintain and build any kind of resume using Google Spreadsheets. This was develop as a personal project to help a friend who was struggling spending up to an hour to make a custom resumes. TRY IT NOW.

For the latest version, access https://resume-builder.js.org.

Features

Online viewer

Create a GitHub repo like this one with the name resume.json and a file called resume.json in a branch called main and following the JSON schema from github.com/jsonresume/resume-schema v0.0.12.

Then you can access your resume via https://https://blopa.github.io/Legacy-Resume-Builder/v3/view/TEMPLATE/GITHUB_USER, for example this URL: https://https://blopa.github.io/Legacy-Resume-Builder/v3/view/default/blopa. You can also append /lang to the end of the URL to add a proper translation to your resume, for example https://https://blopa.github.io/Legacy-Resume-Builder/v3/view/default/blopa/es.

Available Translations

We currently have translations for English, Spanish and Brazilian Portuguese, those are going to be used to translate sections of your resume, like the title "Publications", etc.

Don't like the way a translation key is translated? For example, you might prefer using "Projects" instead of "Publications".

Simply add a custom __translations__ object to your resume.json file with the keys you would like to translate and their new translation, for example:

{
  "__translation__": {
    "publications": "Projects",
    "education": "Study"
  }
}

You can also add it to your spreadsheet by creating columns with the value __translation__, like: ScreenShot

Would you like to have your language added to Resume Builder? Create a Pull Request.

Usage

First of all you need to create a Google Spreadsheet following the same rules as this one (you can make a copy if you like) and populate with your resume information.

  • name: Your full name
  • label: Your resume Job Title
  • picture: A URL for your picture
  • summary: Summary of yourself
  • website/url: Your website URL
  • email: Your email
  • phone: Your phone number
  • address: Your address
  • postalCode: Your postal code
  • city: City where you're located
  • region: Region where you're located
  • countryCode: Country code where you're located
  • network: Social media name
  • username: Social media username
  • translation: Add your custom translations

Libraries

So a big thanks to all the developers that worked really hard on these libs and make our day easier :D.

Deployment

Run npm run build then copy the public/ folder into your website root directory. Done.

Example

The following JSON is a result of this Google Spreadsheet. For a better view of the JSON click here.

{
  "basics": {
    "name": "John Doe",
    "label": "Programmer",
    "picture": "",
    "email": "john@gmail.com",
    "phone": "(912) 555-4321",
    "website": "http://johndoe.com",
    "summary": "A summary of John Doe...",
    "location": {
      "address": "2712 Broadway St",
      "postalCode": "CA 94115",
      "city": "San Francisco",
      "countryCode": "US",
      "region": "California"
    },
    "profiles": [{
      "network": "Twitter",
      "username": "john",
      "url": "http://twitter.com/john"
    }]
  },
  "work": [{
    "company": "Company",
    "position": "President",
    "website": "http://company.com",
    "startDate": "2013-01-01",
    "endDate": "2014-01-01",
    "summary": "Description...",
    "highlights": [
      "Started the company"
    ]
  }],
  "volunteer": [{
    "organization": "Organization",
    "position": "Volunteer",
    "website": "http://organization.com/",
    "startDate": "2012-01-01",
    "endDate": "2013-01-01",
    "summary": "Description...",
    "highlights": [
      "Awarded 'Volunteer of the Month'"
    ]
  }],
  "education": [{
    "institution": "University",
    "area": "Software Development",
    "studyType": "Bachelor",
    "startDate": "2011-01-01",
    "endDate": "2013-01-01",
    "gpa": "4.0",
    "courses": [
      "DB1101 - Basic SQL"
    ]
  }],
  "awards": [{
    "title": "Award",
    "date": "2014-11-01",
    "awarder": "Company",
    "summary": "There is no spoon."
  }],
  "publications": [{
    "name": "Publication",
    "description": "Company",
    "releaseDate": "2014-10-01",
    "website": "http://publication.com",
    "summary": "Description..."
  }],
  "skills": [{
    "name": "Web Development",
    "level": "Master",
    "keywords": [
      "HTML",
      "CSS",
      "Javascript"
    ]
  }],
  "languages": [{
    "language": "English",
    "fluency": "Native speaker"
  }],
  "interests": [{
    "name": "Wildlife",
    "keywords": [
      "Ferrets",
      "Unicorns"
    ]
  }],
  "references": [{
    "name": "Jane Doe",
    "reference": "Reference..."
  }],
  "__translation__": {
    "awards": "Prizes",
    "volunteers": "Volunteers",
    "skills": "Skills",
    "references": "References",
    "publications": "Projects",
    "languages": "Languages",
    "interests": "Interests",
    "education": "Education", 
    "summary": "Summary",
    "experience": "Experience",
    "at": "at"
  }
}

Screenshot

Google Spreadsheet example ScreenShot

Built Resume ScreenShot

Printing Resume ScreenShot

Release Notes

  • v3.1.1:
    • Fix Resume Viewer page for SSR
  • v3.1.0:
    • Update spreadsheet and JSON schema
    • Fix template selector not using the global state
    • Add option to set language in the Resume Viewer page
    • Other small improvements (lintering) in the code
    • Improve JSON object generation
    • Improve Default resume template
    • Add custom translations
  • v3.0.6:
    • Update dependency packages versions
  • v3.0.5:
  • v3.0.4:
    • Fix React suspense on the resume viewer page.
  • v3.0.3:
  • v3.0.2:
    • Fix template selector
    • Fix interests toggler
  • v3.0.1:
  • v3.0.0:
    • Rebuild using Gatsby.

Complete Release Notes here

Thanks to

F.A.Q.

Q: Can you implement <???> function?

A: I can try. Open an issue, and I'll see what I can do.

Q: Your project is awesome. How can I help?

A: Thank you! You can help by codding more features, creating pull requests, or donating via https://bunq.me/BuyMeASoda

TODO

  • Actually create a second template
  • Add unit tests
  • Add list of recent used documents
  • Add option to save a built resume
  • Add check for valid spreadsheet URL on text input
  • Add various missing error handlers
  • Add job offers based on uploaded CV? (check for online APIs)

License

MIT License

Copyright (c) 2021 blopa

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Free Software, Hell Yeah!