Code Monkey home page Code Monkey logo

portfolio-generator's Introduction

portfolio-generator

JS framework to dynamically generate a portfolio site from a JSON resume

DEMO | My portfolio

Features:

  • Framework generates a responsive website by reading information from resume.json
  • Adapts to different screen sizes from phones to desktops
  • Ability to choose the order of diffrent sections
  • Ability to create image galleries for projects
  • All sections are optional; any section can be skipped
  • Ability to have custom names for different project sections

Technical:

  • The code for generating the page is in builder.js and constants.js.
  • It reads the json file using an ajax call to the address listed at the top in constants.js
  • index.html contains all the HTML, CSS and JS in minified format. It will read the resume listed at var RESUME_LOCATION="https://raw.githubusercontent.com/" + GITHUB_USERNAME +"/portfolio-generator/master/resume.json";
  • The GITHUB_USERNAME is picked up from the username.js
  • To host your site qucikly you can put the index.html and username.js on your site, fork this repo and replace content in resume.json
  • See below for how to control different views.

Display Order:

  • The order of different sections is controlled by "displayOrder" in JSON.
  • If you don't want a section to appear on the site, just remove it from the displayOrder
  • Anything that's empty in the "personal" section won't be shown on the site.

Project Sections:

  • Project sections are defined in the "projectSections" as an array.
  • "title" wil be the title of the project section.
  • Project sections appear in same order as they are listed.

Projects:

  • Images for the pop up gallery are listed in the "gallery" array. They appear in the order they are listed in.
  • For bulleted project description, make the "description" attribute a json array and leave out the "gallery"
  • For a paragrap style description, make the "desctiption" a simple string.
  • If you don't want th "Link to Project" to show up, just leave out the "link" attribute.

Work Experience/ Volunteer:

  • If a "link" is included for the org, the organization name will an tag with the link, otherwise simple text.
  • Highlights can be included in the "highlights" as an array. Highlights are optional as well.
  • The "dates" are treated as a string value, so they can be any format.

Pull requests with improvements are welcome.

If you have any questions, please reachout here or @navdeepsekhon9

portfolio-generator's People

Contributors

navdeepsekhon avatar s3b4s avatar m5r avatar

Watchers

James Cloos avatar Aditya Prakash avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.