From 9d1380d0bbb112a03d641363d1ea550c63147d02 Mon Sep 17 00:00:00 2001 From: julien Lengrand-Lambert Date: Sat, 17 Jun 2017 18:28:58 +0200 Subject: [PATCH] Begin writing readme * Add embedded component as example --- README.md | 51 +++++++++++++++++++ .../another-component/another-component.html | 20 ++++++++ .../example-component/example-component.html | 3 ++ app/index.html | 2 - package.json | 2 +- 5 files changed, 75 insertions(+), 3 deletions(-) create mode 100644 README.md create mode 100644 app/components/another-component/another-component.html diff --git a/README.md b/README.md new file mode 100644 index 0000000..45d6de1 --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ +# A simple example of Polymer project with hot reloading + +## To test it + +``` +$ npm install +``` + +and then + +``` +$ bower install +``` + +or + +``` +$ ./node_modules/.bin/bower install +``` + +in case you don't have [bower](TBD) installed globally. + +Finally, simply start the service + +``` +$npm start +``` + +and modify the component. The browser will be reloaded dynamically as you modify code. + +## How it works + +The project simply make use of [browser-sync](TBD). + +The actual command line used is the following: + +``` +$ browser-sync start --server app -f app --serveStatic bower_components --no-notify +``` + +* The command expects your code / project to be sitting in the `app` folder. Change as desired +* `bower_components` files will be served synamically, which means you don't need to reference the `bower_components folder when using external dependencies`. + + +## Author + +* Julien Lengrand-Lambert <@jlengrand> + +## LICENSE + +See LICENSE file \ No newline at end of file diff --git a/app/components/another-component/another-component.html b/app/components/another-component/another-component.html new file mode 100644 index 0000000..d11efa7 --- /dev/null +++ b/app/components/another-component/another-component.html @@ -0,0 +1,20 @@ + + + + + + \ No newline at end of file diff --git a/app/components/example-component/example-component.html b/app/components/example-component/example-component.html index 9a274f0..73a49f3 100644 --- a/app/components/example-component/example-component.html +++ b/app/components/example-component/example-component.html @@ -1,4 +1,5 @@ + - - diff --git a/package.json b/package.json index 07d6637..aacf466 100644 --- a/package.json +++ b/package.json @@ -6,7 +6,7 @@ "scripts": { "start": "browser-sync start --server app -f app --serveStatic bower_components --no-notify" }, - "author": "Julien Lengrand-Lambert ", + "author": "Julien Lengrand-Lambert ", "license": "MIT", "devDependencies": { "browser-sync": "^2.18.12",