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.
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.
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:
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:
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).
If you use VS Code, we highly recommend the lit-plugin extension, which enables some extremely useful features for lit-html templates:
- Syntax highlighting
- Code completion
- Hover-over docs
- Jump to definition
- Quick Fixes
The project is setup to recommend lit-plugin to VS Code users if they don't already have it installed.
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
To lint the project run:
npm run lint
Prettier is used for code formatting. It has been pre-configured according to the Lit's style. You can change this in
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.
Package is published automatically by gh actions from main branch. To upgrade version run:
npm version patch
<script type="module" src="https://unpkg.com/@pragmasoft-ukraine/kite-chat-component/dist/kite-chat-component.mjs"></script>
See Get started on the Kite Chat docs site for more information.