Skip to content
TypeScript JavaScript HTML Other
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Switch from CircleCI to GitHub Actions (#384) Jan 10, 2020
packages Bump @typescript-eslint/eslint-plugin from 2.7.0 to 2.14.0 (#366) Jan 10, 2020
.eslintignore Adding recipes.lwc.dev to README's Jun 6, 2019
.eslintrc.js Release 1.3.9 (#323) Nov 19, 2019
.gitignore
.npmignore Initial commit May 29, 2019
.prettierignore Release 1.3.5 (#250) Oct 16, 2019
.prettierrc
CHANGELOG.md Release 1.3.12 (#351) Dec 7, 2019
CONTRIBUTION.md Text fixes Jun 14, 2019
LICENSE.md
README.md Switch from CircleCI to GitHub Actions (#384) Jan 10, 2020
lerna.json Initial commit May 29, 2019
package.json Bump lint-staged from 8.2.1 to 9.3.0 (#171) Sep 23, 2019
yarn.lock

README.md

create-lwc-app

A tool for setting up your Lightning Web Components projects.

Github Workflow oclif lerna

Version Downloads/week create-lwc-app

Version Downloads/week lwc-services

Quick Start

To get up and running execute the following command in a shell/terminal:

npx create-lwc-app your-app-name

To run this you must have Node.js installed with at least npm 5.2+. You should be familiar with either npm or yarn. The npx tool is a package runner that installs with npm 5.2+.

This will run a npx installation of create-lwc-app, guide you through the short setup, and then create a new Lightning Web Components project for you.

Then run yarn watch (or npm run watch depending on what you chose during the npx installation). Done!

Live App

If you want to see Lightning Web Components in action check out https://recipes.lwc.dev.

So what's this tool about?

Technically it's a toolchain that gives you a quickstart experience for developing with Lightning web components. This project consists of two packages:

It is focused on providing a quick and customizable onboarding experience when you want to develop with Lightning Web Components. If you want to develop Lightning Web Components on the Salesforce Platform you likely want to use Salesforce CLI instead.

If you haven't heard about Lightning Web Components - it's a new framework, introduced by Salesforce, based on the Web Components specifications. Read more about it in the official documentation.

lwc-services

create-lwc-app is meant to be a one-stop-shop solution. The created project contains everything you need to get started. It adds one dependecy, lwc-services. Find below the list of all the things that are bundled with it. When you create a project with create-lwc-app a number of predefined scripts get added to your package.json.

Configuration

If you want to override certain behavior of lwc-services you can place a lwc-services.config.js file into the root of your app directory. Checkout the example file for possible configuration parameters and values.

Commands

lwc-services build

Creates a new webpack build

USAGE
  $ lwc-services build

OPTIONS
  -d, --destination=destination  [default: ./dist] defines the directory where the build is stored
  -m, --mode=mode                [default: development] defines the mode for the build (production|development)
  -n, --noclear                  setting this will not re-create the build dir
  -w, --webpack=webpack          location of custom webpack configuration file

EXAMPLES
  lwc-services build
  lwc-services build -d ./public --noclear

lwc-services serve

Runs a Lightning Web Components project with a local Express server

USAGE
  $ lwc-services serve

OPTIONS
  -d, --directory=directory  [default: ./dist] defines the directory where the build is stored
  -i, --host=host            [default: 0.0.0.0] sets the hostname/IP address
  -o, --open                 opens the site in the default browser
  -p, --port=port            [default: 3002] configures the port of the application

EXAMPLES
  lwc-services serve
  lwc-services serve -p 3998 -i 192.168.178.12

lwc-services sniff

Exports configuration information. It's not a full "eject" out of this tool. Yet.

USAGE
  $ lwc-services sniff

OPTIONS
  -d, --directory=directory  (required) exports configuration files to the given directory
  -w, --webpack=webpack      location of custom webpack configuration file

EXAMPLE
  lwc-services sniff -d somedirectory

lwc-services test

Runs tests for Lightning Web Components


Runs Jest tests for Lightning Web Components

USAGE
  $ lwc-services test:unit

OPTIONS
  -c, --coverage                 collects a coverage report
  -d, --debug                    runs tests in debug mode (https://jestjs.io/docs/en/troubleshooting)
  -p, --passthrough=passthrough  subsequent command line args are passed through (https://jestjs.io/docs/en/cli)
  -r, --runInBand                runs tests serially (slower, but often needed when running on CI systems)
  -w, --watch                    runs in watch mode and re-runs tests on file changes

EXAMPLES
  lwc-services test:unit
  lwc-services test:unit --coverage
  lwc-services test:unit -w

Runs WebDriver tests for Lightning Web Components

USAGE
  $ lwc-services test:wdio

EXAMPLES
  lwc-services test:wdio

lwc-services watch

Runs a Lightning Web Components project in watch mode

USAGE
  $ lwc-services watch

OPTIONS
  -i, --host=host        [default: 0.0.0.0] sets the hostname/IP address
  -m, --mode=mode        [default: development] defines the mode for the build (production|development)
  -o, --open             opens the site in the default browser
  -p, --port=port        [default: 3001] configures the port of the application
  -w, --webpack=webpack  location of custom webpack configuration file

EXAMPLES
  lwc-services watch
  lwc-services watch -p 3998 -i 192.168.178.12 -m production

Contribution

If you have great ideas on how to extend this tool - feel free to open new issues, and then PR something in. ;-)

Please read the contribution guideline for that. Thanks!

You can’t perform that action at this time.