GithubHelp home page GithubHelp logo

startpolymer / polymer-starter-kit-old Goto Github PK

View Code? Open in Web Editor NEW
36.0 6.0 14.0 554 KB

Polymer Starter Kit is a boilerplate for web development.

License: MIT License

HTML 16.04% JavaScript 83.82% CSS 0.14%

polymer-starter-kit-old's Introduction

Polymer Starter Kit

Join the chat at https://gitter.im/StartPolymer/polymer-starter-kit

Polymer Starter Kit is a boilerplate for web development using Web Components and modern tools.

Keeping up to date with Web Starter Kit, HTML5 Boilerplate, Polymer generator and Gulp generator.

Following The 10 Commandments of Modern Web Application

DEMO

Features

Installation

Tools on Ubuntu

# Add Ruby repository
sudo add-apt-repository -y ppa:brightbox/ruby-ng
# Script to install NodeSource repository
curl -sL https://deb.nodesource.com/setup | sudo bash -
# Install Git, Node.js and Ruby
sudo apt-get install -y git nodejs ruby2.2
# Install Bower, Gulp and NPM
sudo npm install -g bower gulp npm
# Install Sass
sudo gem install sass

Usage

Fork this repository

Syncing a fork of a repository to keep it up-to-date with the upstream repository.

or

Clone this repository to separate branch psk

git clone https://github.com/StartPolymer/polymer-starter-kit.git <my-repo-name>
cd <my-repo-name>
git branch -m psk
git checkout -b master
git remote rename origin psk
git remote add origin https://github.com/<user>/<my-repo-name>.git
git push -u origin master

How to use Git

Install dependencies

bower install && npm install

Check out the variables

Serve to local and external URL

http://localhost:9000 and http://<Your IP>:9000

gulp serve

Build and serve the output from the dist build

gulp serve:dist

Build the app

gulp

Build a polymer element

Check out the file structure of Polymer Demo element

gulp build:el

Explain psk- prefix

psk- prefix in file names is for git merging with psk branch without conflicts

Deploy 🎉

Deploy to GitHub Pages

First you need to be sure you have a gh-pages branch. If you don't have one, you can do the following:

git checkout --orphan gh-pages
git rm -rf .
touch README.md
git add README.md
git commit -m "Init gh-pages"
git push --set-upstream origin gh-pages
git checkout master
gulp deploy:gh

Tools

PageSpeed Insights

gulp pagespeed

Extending

Use a recipes for integrating other popular technologies like CoffeeScript. Or this a recipes.

bower install web-component-tester --save-dev
npm install web-component-tester --save-dev

Contributing 👍

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Make your changes
  4. Run the tests, adding new ones for your own code if necessary
  5. Commit your changes (git commit -am 'Added some feature')
  6. Push to the branch (git push origin my-new-feature)
  7. Create new Pull Request

Copyright (c) 2015 Start Polymer (http://startpolymer.org)

polymer-starter-kit-old's People

Contributors

josefjezek avatar gitter-badger avatar

Stargazers

Ganesan Karuppaiya avatar Hendry Syamsudin avatar Veerendra Kumara avatar Ionel Cristian Mărieș avatar 杨松 avatar Erik Fetzer avatar Eterna2 avatar Thomas Gratier avatar Nick Waywood avatar  avatar Joost avatar Ardiansyah Putra avatar Honggi Kim avatar Jan Killian avatar Thomas Roussarie avatar Sylvain Emery avatar Michal Skrabacz avatar Karol Fabjańczuk avatar Kelly Fox avatar  avatar  avatar MuyBien avatar ruedap avatar Hiroki Tani avatar Nathan Leniz avatar Saravanakrishnan Pk avatar  avatar Tomáš Zvěřina avatar  avatar rough avatar Oleh Zasadnyy avatar Evgenii Khramkov avatar Taras Trishchuk avatar hwsw avatar Hugo Dias avatar  avatar

Watchers

 avatar rough avatar James Cloos avatar Chris Weber avatar  avatar Axentioi Alexandru avatar

polymer-starter-kit-old's Issues

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.