https://github.com/alexw00/web-components-ts

A basic template for working with Web Components in Typescript.
https://github.com/alexw00/web-components-ts

typescript web-components web-starter

Last synced: 5 days ago
JSON representation

A basic template for working with Web Components in Typescript.

• Host: GitHub
• URL: https://github.com/alexw00/web-components-ts
• Owner: AlexW00
• Created: 2022-07-20T18:19:22.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-08-11T09:55:56.000Z (over 2 years ago)
• Last Synced: 2024-12-23T00:43:31.683Z (13 days ago)
• Topics: typescript, web-components, web-starter
• Language: TypeScript
• Homepage:
• Size: 342 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Typescript Web Components starter template

This repo contains a basic template for working with Web Components in Typescript.

## Features

Web Components allow you to create custom HTML elements that can be used in your web pages. This starter template contains basic classes to work with them. The template is:

- ⚛️ Modular:

  - write HTML, CSS, and TypeScript in separate files

  - Models and ViewModels, keep the state separate from the DOM

- 🪶 Minimal:

  - no external dependencies, only Vite and vanilla TypeScript

- 💪 Powerful:

  - pubSub pattern for event handling and communication

## Documentation:

-> see [📖 Documentation](docs/documentation.md)

## Setup

1. use the template to create your own repo

2. clone your repo

3. run `npm install`

### Development

1. run `npm run dev`

2. make changes to the code

### Build preview

1. run `npm run build`

2. run `npm run preview` and open the preview in a browser