Git Product home page Git Product logo

web-component-pages's Introduction

Web-Component-Pages

This is a template for multiple microsites using web components based on lit-element using lit-html.

Built with open-wc recommendations

There are two types of web components in this template:

  • components
  • views

Both components & views are technically web components. The only difference is that views can be exported as standalone websites including all components in it.

Quickstart

To get started:

npm install
# requires node 10 & npm 6 or higher

npm run start
# to start a storybook instance for component development

npm run scaffold
# to generate a new component or view

npm run build
# to collect and bundle all necessary components for a specifix view and export them for production ready code

Start developing

A new standalone site can be created by generating a new view npm run scaffold. Follow the setups instructions to generate a view. Use PascalCase for the name: ExampleViewName

Add some components by using the scaffolder again. Every component extends the LitElement class and fully features lit-html. See this documentation for web component development.

Build a page

If your want to export a view you can use the build setup. Run npm run build to start the export setup and select the view you want to bundle. Once it finishes the view will lay minfied and optimized inside of the dist folder.

Scripts

  • start runs your app for development, reloading on file changes
  • scaffold starts a prompt to get you through a component/view generator
  • build builds your production ready view and outputs it in your dist directory
  • lint runs the linter for this project

Tooling configs

For most of the tools, the configuration is in the package.json to reduce the amount of files in the project.

web-component-pages's People

Contributors

samsour avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.