{"id":14070191,"url":"https://github.com/pragmasoft-ua/kite-chat-frontend","last_synced_at":"2025-07-30T07:30:58.900Z","repository":{"id":59763129,"uuid":"530677871","full_name":"pragmasoft-ua/kite-chat-frontend","owner":"pragmasoft-ua","description":"🪁Kite chat is a livechat web component and protocol","archived":false,"fork":false,"pushed_at":"2024-08-09T00:40:31.000Z","size":7881,"stargazers_count":15,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-11-13T17:08:12.538Z","etag":null,"topics":["chat","javascript","lit-element","livechat","livechat-app","tailwindcss","typescript","web-components"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pragmasoft-ua.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-08-30T13:48:54.000Z","updated_at":"2024-08-08T23:51:01.000Z","dependencies_parsed_at":"2023-12-29T00:26:35.226Z","dependency_job_id":"0bb616af-508a-4089-a9fa-1daf5907008e","html_url":"https://github.com/pragmasoft-ua/kite-chat-frontend","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":"lit/lit-element-starter-ts","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pragmasoft-ua%2Fkite-chat-frontend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pragmasoft-ua%2Fkite-chat-frontend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pragmasoft-ua%2Fkite-chat-frontend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pragmasoft-ua%2Fkite-chat-frontend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pragmasoft-ua","download_url":"https://codeload.github.com/pragmasoft-ua/kite-chat-frontend/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228102597,"owners_count":17869887,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chat","javascript","lit-element","livechat","livechat-app","tailwindcss","typescript","web-components"],"created_at":"2024-08-13T07:07:32.865Z","updated_at":"2024-12-04T11:31:26.943Z","avatar_url":"https://github.com/pragmasoft-ua.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# 🪁 K1te chat frontend\n\n![Kite Chat](https://github.com/pragmasoft-ua/kite-chat-frontend/blob/main/kite-chat-light.png?raw=true)\n\n![deploy](https://github.com/pragmasoft-ua/kite-chat-frontend/actions/workflows/deploy.yml/badge.svg)\n\n[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/@pragmasoft-ukraine/kite-chat-component)\n\n[Docs](https://www.k1te.chat/)\n\n[Demo](https://www.k1te.chat/en/start/demo/)\n\nThis project includes **kite-chat** web component, which can be used independently with any 3rd party backend, 🪁 K1te chat client and protocol driver to communicate with the [existing backend](https://github.com/pragmasoft-ua/kite-chat), and documentation for both these modules as a static site (Astro).\n\nWeb component is built using LitElement with TypeScript and Tailwind CSS.\n\nProject is generated from the `lit-starter-ts` template in [the main Lit\nrepo](https://github.com/lit/lit). Issues and PRs for this template should be\nfiled in that repo.\n\n## Setup\n\nInstall dependencies:\n\n```bash\nnpm i\n```\n\nThis project uses npm [workspaces](https://docs.npmjs.com/cli/using-npm/workspaces) and typescript [project references](https://www.typescriptlang.org/docs/handbook/project-references.html).\n\nYou need to run `npm run compile` before you start working on the project in your IDE to prebuild type definitions for incremental builds, otherwise you may experience typescript module resolution errors.\n\n## Build\n\nTo build the packages and docs run:\n\n```bash\nnpm run build\n```\n\nTo build only the component, run:\n\n```bash\nnpm run build -w @pragmasoft-ukraine/kite-chat-component\n```\n\n[More info about component build](packages/kite-chat-component/README.md#build)\n\nTo build only the chat client, run:\n\n```bash\nnpm run build -w @pragmasoft-ukraine/kite-chat\n```\n\n[More info about protocol driver build](packages/kite-chat/README.md#build)\n\nTo build only the documentation site, run:\n\n```bash\nnpm run build -w @pragmasoft-ukraine/kite-chat-docs\n```\n\n[More info about docs build](packages/kite-chat-docs/README.md#build)\n\n## Testing\n\nTests can be run with the `test` script, which will run test command in packages if it exist:\n\n```bash\nnpm test\n```\n\nTo test only the component, run:\n\n```bash\nnpm run test -w @pragmasoft-ukraine/kite-chat-component\n```\n\n[More info about component testing](packages/kite-chat-component/README.md#test)\n\nTo test only the chat client, run:\n\n```bash\nnpm run test -w @pragmasoft-ukraine/kite-chat\n```\n\n[More info about driver testing](packages/kite-chat/README.md#test)\n\n## Dev Server\n\nThe default start command will run docs locally:\n\n```bash\nnpm run start\n```\n\n[More info about docs dev server](packages/kite-chat-docs/README.md#dev-server)\n\nTo run the component dev server:\n\n```bash\nnpm run start -w @pragmasoft-ukraine/kite-chat-component\n```\n\n[More info about component dev server](packages/kite-chat-component/README.md#dev-server)\n\nTo run the chat client dev server:\n\n```bash\nnpm run start -w @pragmasoft-ukraine/kite-chat\n```\n\n[More info about driver dev server](packages/kite-chat/README.md#dev-server)\n\n## Editing\n\nIf you use VS Code, we highly recommend the [lit-plugin extension](https://marketplace.visualstudio.com/items?itemName=runem.lit-plugin), which enables some extremely useful features for lit-html templates:\n\n- Syntax highlighting\n- Type-checking\n- Code completion\n- Hover-over docs\n- Jump to definition\n- Linting\n- Quick Fixes\n\nThe project is setup to recommend lit-plugin to VS Code users if they don't already have it installed.\n\n## Linting\n\nLinting of TypeScript files is provided by [ESLint](eslint.org) and [TypeScript ESLint](https://github.com/typescript-eslint/typescript-eslint). In addition, [lit-analyzer](https://www.npmjs.com/package/lit-analyzer) is used to type-check and lint lit-html templates with the same engine and rules as lit-plugin.\n\nThe 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`.\n\nTo lint the project run:\n\n```bash\nnpm run lint\n```\n\n## Formatting\n\n[Prettier](https://prettier.io/) is used for code formatting. It has been pre-configured according to the Lit's style. You can change this in `.prettierrc.json`.\n\nPrettier has not been configured to run when committing files, but this can be added with Husky and and `pretty-quick`. See the [prettier.io](https://prettier.io/) site for instructions.\n\n## CI/CD Workflow\n\nThis project utilizes GitHub Actions for Continuous Integration and Deployment. The workflow includes linting, testing, documentation builds, and npm package publishing.\n\n### Setup gh actions\n\n1. **GitHub Actions Secrets:**\n\n   - Create `NPM_TOKEN` secret with your npm token.\n   - Ensure `GITHUB_TOKEN` secret is available for deployment.\n\n2. **Triggers:**\n\n   - Workflow triggers on `main` and `test` branch pushes.\n   - Manual triggering is available in the Actions tab.\n\n3. **Dependencies:**\n\n   - Node.js v18 is used. Ensure compatible dependencies.\n\n4. **Artifact Uploads:**\n\n   - Documentation and package builds artifacts are uploaded.\n\n5. **Deployment:**\n   - Documentation auto-deploys to GitHub Pages.\n   - npm packages auto-publish with version checks.\n\n## More information\n\nSee [Get started](https://www.k1te.chat/en/start/getting-started/) on the documentation site for more information on how to jumpstart using the chat.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpragmasoft-ua%2Fkite-chat-frontend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpragmasoft-ua%2Fkite-chat-frontend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpragmasoft-ua%2Fkite-chat-frontend/lists"}