https://github.com/sbeleidy/poly-me

A web based résumé using polymer
https://github.com/sbeleidy/poly-me

Last synced: about 23 hours ago
JSON representation

A web based résumé using polymer

• Host: GitHub
• URL: https://github.com/sbeleidy/poly-me
• Owner: sbeleidy
• Created: 2016-07-02T09:25:14.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-05-29T19:04:45.000Z (over 7 years ago)
• Last Synced: 2024-10-10T12:56:10.731Z (29 days ago)
• Language: HTML
• Homepage: https://webcomponents.org/element/sbeleidy/poly-me
• Size: 2.8 MB
• Stars: 7
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# poly-mé

[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://beta.webcomponents.org/element/sbeleidy/poly-me)

[![Join the chat at https://gitter.im/sbeleidy/poly-me](https://badges.gitter.im/sbeleidy/poly-me.svg)](https://gitter.im/sbeleidy/poly-me?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

A web based résumé using polymer

## Installation & Setup

```

bower install poly-me

```

## Usage

```html

  

```

### JSON Profile Spec

Font awesome icons for social accounts. See names [here](http://fontawesome.io/icons/#brand)

The `.json` file structure should be as follows:

```json

{

  "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](https://www.npmjs.com/package/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](https://github.com/Polymer/web-component-tester). Run `polymer test` to run your application's test suite locally.