smddzcy / cv

A simple, modern CV / resume template.
MIT License
103 stars 49 forks source link
beginner-project cv grunt html javascript pdf resume resume-creator resume-template

CV

Build Status Build status Built with Grunt MIT License

A simple, modern CV / resume template. Click here to see an example.

Creating Your CV

(You need npm in order to build the project. If it's not installed, install npm from here)

  1. Install the dependencies:

    npm install
  2. Fill in the .json files in src/contents with your information. Click here to find out how to fill those files.

  3. Run grunt build and get your fresh CV in the HTML format from dist/index.html.

If you want it in the PDF format, you can print the page as a PDF from your browser, just like I do all the time.

Note: src/contents/color_palette.json contains the color settings of your CV. There is a fixed set of colors, and you can look at your options from that file (colorOptions field) or here or src/img/color-palette.jpg file.

Filling Your Information

personal_info.json

  {
    "name": "Samed Düzçay",
    "profession": "Software Engineer",
    "summary": "A confident, self-motivated and self-taught software engineer with 5 years of experience in back-end and front-end web development. A deep researcher and a passionate learner in every aspect of his life, with good analytical and verbal skills.",
    "mail": "samedduzcay@gmail.com",
    "address": {
      "title": "Şişli, Istanbul, TURKEY",
      "url": "https://www.google.com/maps/place/Şişli,+19+Mayıs,+34360+Şişli%2Fİstanbul,+Turkey/@41.0602771,28.9790232,15z/data=!3m1!4b1!4m5!3m4!1s0x14cab71b4b2a7585:0x8f4cb3b604ac157f!8m2!3d41.060278!4d28.987778"
    },
    "personal_site": {
      "title": "smddzcy.com",
      "url": "https://smddzcy.com/"
    },
    "github": {
      "title": "github.com/smddzcy",
      "url": "https://github.com/smddzcy"
    },
    "linkedin": {
      "title": "linkedin.com/in/smddzcy",
      "url": "https://www.linkedin.com/in/smddzcy"
    },
    "hackerrank": {
      "title": "hackerrank.com/smddzcy",
      "url": "https://www.hackerrank.com/smddzcy"
    },
    "google_analytics": "UA-11122333-4"
  }

Every field is optional, except name and profession. Also, you can include a photo with a photo field like this:

  {
    ... ,
    "photo": "src/photo.png OR A URL TO YOUR PHOTO"
  }

experiences.json

[{
  "company": "Pisano",
  "role": "Software Engineer",
  "date": "06/2016 - Present",
  "location": "Istanbul, Turkey",
  "description_bullets": [
    "Full-stack web development using modern technologies: HTML5, LESS, AngularJS, CoffeeScript, Ruby on Rails.",
    "Working in a team-based development environment using agile methodologies like Kanban and Scrum."
  ]
}, {
  ...
}]

You can also use "description" instead of "description_bullets" with a simple text value like:

[{
  "company": "Pisano",
  "role": "Software Engineer",
  "date": "06/2016 - Present",
  "location": "Istanbul, Turkey",
  "description": "Full-stack web development using modern technologies: HTML5, LESS, AngularJS, CoffeeScript, Ruby on Rails. Working in a team-based development environment using agile methodologies like Kanban and Scrum."
}, {
  ...
}]

Or you can use both, it's up to you.

date, location, description and description_bullets fields are optional.

education.json

  [{
    "name": "Boğaziçi University",
    "degree": "B.S. Computer Engineering",
    "date": "09/2015 - Present",
    "description": "GPA: 3.67/4. Member of <a href=\"http://compec.boun.edu.tr/\" target=\"_blank\">COMPEC (Boğaziçi University IT Club)</a> and <a href=\"http://www.budak.boun.edu.tr\" target=\"_blank\">BÜDAK (Boğaziçi University Mountaineering Club)</a>."
  }, {
    ...
  }]

As you can see, HTML is allowed inside description values.

date and description fields are optional.

skills.json

  [
    "Full-Stack Web Development",
    "Object-Oriented Analysis, Design, Programming (OOA/OOD/OOP)",
    "Algorithm Design and Analysis",
    ...
  ]

projects.json

  [{
    "name": "BounCoursePlanner",
    "description": "Course schedule planner for Boğaziçi University students. Finds the best schedule, which has the less conflicts and most free hours they want.",
    "github": "https://github.com/smddzcy/BounCoursePlanner",
    "link": "https://smddzcy.com/BounCoursePlanner/"
  }, {
    ...
  }]

github and link fields are optional.

certificates.json

  [{
    "title": "Adwords Certification",
    "authority": "Google",
    "date": "10/2015 - 10/2016",
    "description": "License: <a href=\"https://www.google.com/partners/?hl=tr#i_profile;idtf=108560574407568073059;\" target=\"_blank\">108560574407568073059</a>"
  }, {
    ...
  }]

date and description fields are optional.

volunteering_experiences.json

  [{
    "organization": "Boğaziçi University, Entrepreneurship Center",
    "role": "Full Stack Developer",
    "date": "09/2016 - Present",
    "location": "Istanbul, Turkey",
    "description": "Volunteer member of the development team. Actively working on several projects as the key team member."
  }, {
    ...
  }]

You can use description_bullets instead of description just like in the experiences.json.

date, location, description and description_bullets fields are optional.

honors.json

  [{
    "title": "Comodo Hackathon - 1st Place",
    "date": "12/2016",
    "description": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."
  }, {
    ...
  }]

date and description fields are optional.

languages.json

  [{
    "name": "Turkish",
    "level": "Native"
  }, {
    "name": "English",
    "level": "C2, Proficient"
  }, {
    ...
  }]

level field is optional.

Contributing

  1. Fork the repo (By clicking the "Fork" button on the upper-right side of the page)
  2. Clone the repo (git clone https://github.com/-YOUR NAME-/cv.git)
  3. Install the dependencies with npm install.
  4. Run grunt and keep it open while making your changes. Please keep the default JSON files while contributing, since I serve my CV to some places directly from this repo.
  5. When you're done, commit (git commit -am "YOUR COMMIT MESSAGE") and push (git push) your changes.
  6. Make a pull request, from here.

You can pick one of the TODO's below and start contributing right away. Thank you so much!

TODO

License

MIT