https://github.com/supunlakmal/polymer
polymer
https://github.com/supunlakmal/polymer
Last synced: 2 months ago
JSON representation
polymer
- Host: GitHub
- URL: https://github.com/supunlakmal/polymer
- Owner: supunlakmal
- Created: 2019-06-16T02:34:05.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-06-16T02:34:12.000Z (almost 6 years ago)
- Last Synced: 2025-01-17T14:55:24.841Z (4 months ago)
- Language: JavaScript
- Size: 44.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Start Polymer 3.0
A simple Polymer 3.0 demo app. See it deployed at [start-polymer3.firebaseapp.com](https://start-polymer3.firebaseapp.com).
Please use the latest version of Chrome or Safari to view the app. It uses native [dynamic imports](https://developers.google.com/web/updates/2017/11/dynamic-import).
If you have done all this before:
```
npm install -g polymer-cli
git clone https://github.com/PolymerLabs/start-polymer3.git
cd start-polymer3
npm install
polymer serve
```
Otherwise:
1. [Set up a development environment for Polymer projects](#setup):
* [Install Polymer CLI prerequisites](#installprerequisites).
* [Install Polymer CLI](#installcli).
2. [Clone, install and serve the `start-polymer3` project locally](#clone).
3. (Optional) [Build the `start-polymer3` project for production](#build).
4. (Optional) [Deploy the `start-polymer3` project](#deploy).
## Set up a development environment for Polymer projects
Before you can serve this project, you will need to install Polymer CLI
and its prerequisites.
### Install Polymer CLI Prerequisites
* [Git](https://git-scm.com/download/)
* [Node.js](https://nodejs.org/en/)
* [npm](https://www.npmjs.com/)
### Install Polymer CLI
When you've installed the prerequisites, run the following command to install the Polymer CLI globally:
```
npm install -g polymer-cli
```
## Clone, install and serve the start-polymer3 project locally
To clone the project, install its dependencies, and serve locally:
```
git clone https://github.com/PolymerLabs/start-polymer3.git
cd start-polymer3
npm install
polymer serve
```
To view the app, open the `applications` link in the latest version of Chrome or Safari. For example:
```
~/start-polymer3 > polymer serve
info: Files in this directory are available under the following URLs
applications: http://127.0.0.1:8081
reusable components: http://127.0.0.1:8081/components/start-polymer3/
```
In the example above, you'd open http://127.0.0.1:8081.
## Build the start-polymer3 project for production
To build the `start-polymer3` app:
```
npm install
polymer build
```
The build is output to `build/es6-unbundled`. To serve the built app locally:
```
cd build/es6-unbundled
polymer serve
```
## Deploy the start-polymer3 project
You can deploy a built Polymer app to any web server. One way is to deploy with Firebase:
### Deploy with Firebase
To deploy the app to your own Firebase project:
1. [Install the Firebase CLI tools](https://firebase.google.com/docs/cli/).
```
npm install -g firebase-tools
firebase login
```
2. From the [Firebase console](https://console.firebase.google.com/), create a Firebase project.
3. [Initialize Firebase in your project folder](https://firebase.google.com/docs/cli/#initializing_a_project_directory).
```
firebase init
```
Complete the Firebase initialization process to set up your project for hosting.
If you are prompted to
* **select Firebase CLI features**, select **Hosting**.
* **select a default Firebase project**, select the project you created from the Firebase console.
* **specify a `public` directory**, you can enter `build/es6-unbundled` to deploy the build configuration supplied with this sample project.
* **configure as a single-page app**, enter `Y`.
* **overwrite `index.html`**, enter `N`.
4. In a text editor, open `firebase.json` from your root project folder.
`hosting.ignore` is a list of files and folders that Firebase will not deploy. Remove the `node_modules` folder from this list and save `firebase.json`.
**firebase.json: Before**
```
{
"hosting": {
"public": "build/es6-unbundled",
"ignore": [
"firebase.json",
"**/.*",
"**/node_modules/**"
],
"rewrites": [
{
"source": "**",
"destination": "/index.html"
}
]
}
}
```
**firebase.json: After**
```
{
"hosting": {
"public": "build/es6-unbundled",
"ignore": [
"firebase.json",
"**/.*"
],
"rewrites": [
{
"source": "**",
"destination": "/index.html"
}
]
}
}
```
4. [Deploy your project](https://firebase.google.com/docs/cli/#deployment) with Firebase.
```
firebase deploy
```