Tools

This documentation is a work in progress. It describes prerelease software, and is subject to change.

Set up LitElement locally

Set up LitElement locally

Install pre-requisites

To work locally with lit-element, you’ll first need to install Git, npm and Node.js, and the Polymer CLI.

Install Git.
Install npm and Node.js.
Update npm:
```
npm install -g npm@latest
```
Install Polymer CLI:
```
npm install -g polymer-cli@latest
```

Read on to create a new LitElement project from scratch, or if you prefer, you can download a sample LitElement project.

Create a new LitElement project

mkdir myproject
cd myproject
npm init -y
npm install --save @polymer/lit-element
npm install --save @webcomponents/webcomponentsjs

Serve your project locally

Create a polymer.json config file, and serve your project:

cd myproject
npm install
echo '{
  "npm": true,
  "moduleResolution": "node",
  "entrypoint": "src/index.html",
  "shell": "src/my-project.js",
  "extraDependencies": [
    "node_modules/@webcomponents/webcomponentsjs/**"
  ],
  "builds": [{
    "name": "mybuild",
    "bundle": true,
    "js": {
      "minify": true
    }
  }]
}' >polymer.json
polymer serve

Build your project for production

Build your project, and serve the build locally:

cd myproject
polymer build
polymer serve build/mybuild