{"id":13818256,"url":"https://github.com/tattersoftware/codeigniter4-chat","last_synced_at":"2025-06-14T16:03:59.812Z","repository":{"id":41811141,"uuid":"238243835","full_name":"tattersoftware/codeigniter4-chat","owner":"tattersoftware","description":"Embedded chat widget for CodeIgniter 4","archived":false,"fork":false,"pushed_at":"2024-01-17T17:41:44.000Z","size":136,"stargazers_count":19,"open_issues_count":3,"forks_count":7,"subscribers_count":4,"default_branch":"develop","last_synced_at":"2025-06-14T16:02:56.589Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tattersoftware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-02-04T15:50:59.000Z","updated_at":"2025-04-25T14:12:43.000Z","dependencies_parsed_at":"2024-06-10T01:47:04.584Z","dependency_job_id":null,"html_url":"https://github.com/tattersoftware/codeigniter4-chat","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/tattersoftware/codeigniter4-chat","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tattersoftware%2Fcodeigniter4-chat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tattersoftware%2Fcodeigniter4-chat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tattersoftware%2Fcodeigniter4-chat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tattersoftware%2Fcodeigniter4-chat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tattersoftware","download_url":"https://codeload.github.com/tattersoftware/codeigniter4-chat/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tattersoftware%2Fcodeigniter4-chat/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259843316,"owners_count":22920308,"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":[],"created_at":"2024-08-04T07:00:37.656Z","updated_at":"2025-06-14T16:03:59.790Z","avatar_url":"https://github.com/tattersoftware.png","language":"PHP","funding_links":[],"categories":["complex"],"sub_categories":[],"readme":"# Tatter\\Chat\n\nEmbedded chat widget for CodeIgniter 4\n\n[![](https://github.com/tattersoftware/codeigniter4-chat/workflows/PHPUnit/badge.svg)](https://github.com/tattersoftware/codeigniter4-chat/actions/workflows/phpunit.yml)\n[![](https://github.com/tattersoftware/codeigniter4-chat/workflows/PHPStan/badge.svg)](https://github.com/tattersoftware/codeigniter4-chat/actions/workflows/phpstan.yml)\n[![](https://github.com/tattersoftware/codeigniter4-chat/workflows/Deptrac/badge.svg)](https://github.com/tattersoftware/codeigniter4-chat/actions/workflows/deptrac.yml)\n[![Coverage Status](https://coveralls.io/repos/github/tattersoftware/codeigniter4-chat/badge.svg?branch=develop)](https://coveralls.io/github/tattersoftware/codeigniter4-chat?branch=develop)\n\n## Quick Start\n\n1. Install with Composer: `\u003e composer require tatter/chat`\n2. Update the database: `\u003e php spark migrate --all`\n3. Publish asset files: `\u003e php spark publish`\n4. Add Chat JS to your layout: `\u003cscript\u003e\u003c?= view('Tatter\\Chat\\Views\\javascript') ?\u003e\u003c/script\u003e`\n4. Add a chat to any view: `\u003c?= chat('my-first-chat') ?\u003e`\n\n## Features\n\n**Chat** allows developers to add a lightweight Bootstrap-style chat client to any page.\n\n## Installation\n\nInstall easily via Composer to take advantage of CodeIgniter 4's autoloading capabilities\nand always be up-to-date:\n```shell\n\u003e composer require tatter/chat\n```\n\nOr, install manually by downloading the source files and adding the directory to\n**app/Config/Autoload.php**.\n\nOnce the files are downloaded and included in the autoload, run any library migrations\nto ensure the database is setup correctly:\n```shell\n\u003e php spark migrate --all\n```\n\n### Assets\n\n**Chat** has JavaScript code as well as asset dependencies that need to be included\nwith any view that has a conversation on it. Assets are managed by the\n[Tatter\\Assets](https://github.com/tattersoftware/codeigniter4-assets) library; you can\npublish all files with CodeIgniter's Publisher: `spark publish`. Be sure to configure\nthe **Assets** filter and apply it to routes (see docs).\n\n### Authentication\n\n**Chat** uses `Tatter\\Users` to determine participants username and display name. You must\nbe sure to include a package that provides `codeigniter4/authentication-implementation`\n(like **Shield**) or make your own (see [Authentication](https://codeigniter4.github.io/CodeIgniter4/extending/authentication.html)\nfor framework requirements).\n\n## Usage\n\nThe easiest way to start a chat is with the helper. Load the helper file (`helper('chat')`)\nand then use the `chat($uid, $title)` command wherever you would use a partial view:\n\n```html\n\u003cdiv id=\"main\"\u003e\n\t\u003ch3\u003eYellow Widgets\u003c/h3\u003e\n\t\u003cp\u003eMain product info here!\u003c/p\u003e\n\t\n\t\u003caside\u003e\n\t\t\u003c?= chat('product-7', 'Live Chat') ?\u003e\n\t\u003c/aside\u003e\n...\n```\n\nThe parameters to `chat()` are optional, and excluding them will load a one-time chat with\na random UID (e.g. for a one-time site visitor).\n\n## Extending\n\nConversations are stored and loaded from the database with the `ConversationModel`, and\nmost of the logic is handled by the Entities. For example, a `Conversation` entity can\n`$conversation-\u003eaddUser($userId)` to join or refresh a user and get back a `Participant`.\nA `Participant` can `$participant-\u003esay('hello world')` to add a `Message`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftattersoftware%2Fcodeigniter4-chat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftattersoftware%2Fcodeigniter4-chat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftattersoftware%2Fcodeigniter4-chat/lists"}