Skip to content

Latest commit

 

History

History
114 lines (70 loc) · 4.34 KB

README.md

File metadata and controls

114 lines (70 loc) · 4.34 KB
Raw

🪁 Kite chat web component

Kite Chat

deploy

Published on webcomponents.org

This project includes kite-chat web component, which can be used independently of the kite-chat backend with any other backend and networking protocol.

Web component is built using LitElement with TypeScript and Tailwind CSS.

Setup

Install dependencies:

npm i

Build

Chat component uses the TypeScript compiler to produce JavaScript that runs in modern browsers.

Chat component uses Vite to bundle package. It bundles code with Rollup, pre-configured to output highly optimized static assets for production.

To build the JavaScript version of your component:

npm run build

Both the TypeScript compiler and lit-analyzer are configured to be very strict. You may want to change tsconfig.json to make them less strict.

Testing

This project uses modern-web.dev's @web/test-runner for testing. See the modern-web.dev testing documentation for more information.

Tests can be run with the test script, which will run your tests against Lit's development mode (with more verbose errors) as well as against Lit's production mode:

npm test

For local testing during development, the test:watch command will run your tests in Lit's development mode (with verbose errors) on every change to your source files:

npm test:watch

Dev Server

Chat component uses Vite as a build tool. It`s dev server provides rich feature enhancements over native ES modules, for example extremely fast Hot Module Replacement (HMR).

To run the dev server and open the project in a new browser tab:

npm run start

There is a development HTML file located at /index.html that you can view at http://localhost:5173/index.html. Note that this command will serve your code using Lit's development mode (with more verbose errors).

Editing

If you use VS Code, we highly recommend the lit-plugin extension, which enables some extremely useful features for lit-html templates:

  • Syntax highlighting
  • Type-checking
  • Code completion
  • Hover-over docs
  • Jump to definition
  • Linting
  • Quick Fixes

The project is setup to recommend lit-plugin to VS Code users if they don't already have it installed.

Linting

Linting of TypeScript files is provided by ESLint and TypeScript ESLint. In addition, lit-analyzer is used to type-check and lint lit-html templates with the same engine and rules as lit-plugin.

The rules are mostly the recommended rules from each project, but some have been turned off to make LitElement usage easier. The recommended rules are pretty strict, so you may want to relax them by editing .eslintrc.json and tsconfig.json.

To lint the project run:

npm run lint

Formatting

Prettier is used for code formatting. It has been pre-configured according to the Lit's style. You can change this in .prettierrc.json.

Prettier has not been configured to run when committing files, but this can be added with Husky and and pretty-quick. See the prettier.io site for instructions.

Publish

Package is published automatically by gh actions from main branch. To upgrade version run:

npm version patch

Script to include component from CDN

<script type="module" src="https://unpkg.com/@pragmasoft-ukraine/kite-chat-component/dist/kite-chat-component.mjs"></script>

More information

See Get started on the Kite Chat docs site for more information.