poly-mé

A web based résumé using polymer

Installation & Setup

bower install poly-me

Usage

  <poly-me src="demo/johnSmith.json"></poly-me>

JSON Profile Spec

Font awesome icons for social accounts. See names here

The .json file structure should be as follows:

{
  "content": {
    "name": "Your name",
    "profileImage": "path to profile image",
    "backgroundImage": "path to background image",
    "position": "Your position or title",
    "location": "Your location",
    "social": {
      "title": "a title to the social section underneath the profile info",
      "profiles": [
        {
          "network": "the icon name from the font awesome cheatsheet see http://fontawesome.io/icons/#brand",
          "link": "the link to go to when clicked"
        },...
      ]
    },
    "sections": [
      // See each section's definition
    ]
  },
  "settings": {
    "primaryColor": "The hex value of the primary color for the app - use something close to the background image colors"
  }
}

Section types are available as separate components with their own documentation. Please see each section's documentation for more information.

Contributing

Install the Polymer-CLI

First, make sure you have the Polymer CLI installed. Then run polymer serve to serve your application locally.

Viewing Your Application

$ polymer serve

Building Your Application

$ polymer build

This will create a build/ folder with bundled/ and unbundled/ sub-folders containing a bundled (Vulcanized) and unbundled builds, both run through HTML, CSS, and JS optimizers.

You can serve the built versions by giving polymer serve a folder to serve from:

$ polymer serve build/bundled

Running Tests

$ polymer test

Your application is already set up to be tested via web-component-tester. Run polymer test to run your application's test suite locally.