Skip to content

Latest commit

 

History

History
72 lines (54 loc) · 3.46 KB

README.md

File metadata and controls

72 lines (54 loc) · 3.46 KB
Raw

Welcome to LETSCSS(*) 👋

A very simple and basic starter boilerplate template based on Lit-Element + Typescript + SASS + Constructible Stylesheet + Storybook and with no bundler involved (thanks to Snowpack 2)

(*) LETSCSS stands for Lit-Element-Typescript-Sass-Constructed-Stylesheet-Storybook

Install

npm run init

Usage

snowpack dev

# if you decide to showcase your webcomponent into storybook, then run this as well
# (note that storybook will be proxified behind snowpack dev server on http://localhost:8080/storybook/) :
cd storybook && npm run storybook

It provides out of the box :

  • TS Compiler watch
  • SASS Compiler watch
  • Sourcemaps
  • Files served on an HTTP Server
  • Global CSS rules being applicable to every Web Components thanks to Constructible StyleSheets
  • Storybook for your components' stories
  • No build tool complexity involved : everything is in the package.json's script section

Compat

As date of this writing, it works with most ever green browsers :
✅ Chrome (79.0.3945.88)
✅ Firefox (72.0.1)
✅ Safari (12.1.1)
✅ Microsoft EDGE (79.0.309.58)
❌ Microsoft Internet Explorer
❌ Microsoft EDGE versions not based on chrome builds, or based on old Chrome version

Behind the scenes

@pika/snowpack (previously named @pika/dev) to convert every compilation dependencies (located in package.json's dependencies section) to web bundles copied once for all (at npm install time) in web_components/ folder)

SASS compilation is splitted in 2 :

  • Applicative SASS compilation
  • Vendors SASS compilation (example illustrated with the foundation CSS lib, but you can use whatever lib you want here).
    Because we don't want to spend all our CPU time for third party vendors SASS dependencies that never change over time.

Storybook relies on storybook-prebuilt (pulled from openwc's demoing storybook package) in order to avoid any build took like babel/webpack.
The important thing you need to understand about this is :

  • To make it work properly, you will have to run npm run storybook:build in order to generate the storybook prebuilt version
  • If you change anything on your storybook config (updating .storybook/* files like adding an addon), then execute this command again in order to update your prebuilt storybook assets
  • Once you have your storybook-prebuilt assets generated, then you can start storybook by running npm run storybook and storybook will be served on http://localhost:8001/

References