https://github.com/stencil-community/stencil-app-starter

Minimal starter project for building web components with Stencil
https://github.com/stencil-community/stencil-app-starter

stenciljs

Last synced: about 6 hours ago
JSON representation

Minimal starter project for building web components with Stencil

• Host: GitHub
• URL: https://github.com/stencil-community/stencil-app-starter
• Owner: stencil-community
• License: mit
• Created: 2017-07-07T01:01:21.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2023-09-25T17:38:41.000Z (about 1 year ago)
• Last Synced: 2024-11-08T15:50:52.884Z (7 days ago)
• Topics: stenciljs
• Language: TypeScript
• Homepage: https://github.com/ionic-team/stencil
• Size: 450 KB
• Stars: 320
• Watchers: 29
• Forks: 102
• Open Issues: 8
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-stencil - stencil-app-starter - Minimal starter project for building web components with Stencil. (Starter Templates / Community)
• awesome-stencil - stencil-app-starter - Minimal starter project for building web components with Stencil. (Starter Templates / Community)

README

        
# Stencil App Starter

Stencil is a compiler for building fast web apps using Web Components.

Stencil combines the best concepts of the most popular frontend frameworks into a compile-time rather than run-time tool.  Stencil takes TypeScript, JSX, a tiny virtual DOM layer, efficient one-way data binding, an asynchronous rendering pipeline (similar to React Fiber), and lazy-loading out of the box, and generates 100% standards-based Web Components that run in any browser supporting the Custom Elements v1 spec.

Stencil components are just Web Components, so they work in any major framework or with no framework at all. In many cases, Stencil can be used as a drop in replacement for traditional frontend frameworks given the capabilities now available in the browser, though using it as such is certainly not required.

Stencil also enables a number of key capabilities on top of Web Components, in particular Server Side Rendering (SSR) without the need to run a headless browser, pre-rendering, and objects-as-properties (instead of just strings).

## Getting Started

To start a new project using Stencil, clone this repo to a new directory:

```bash

npm init stencil app

```

and run:

```bash

npm start

```

To build the app for production, run:

```bash

npm run build

```

To run the unit tests once, run:

```

npm test

```

To run the unit tests and watch for file changes during development, run:

```

npm run test.watch

```