{"id":15146985,"url":"https://github.com/chamale-rac/xmpp","last_synced_at":"2025-04-06T22:47:35.620Z","repository":{"id":255074717,"uuid":"833908812","full_name":"chamale-rac/xmpp","owner":"chamale-rac","description":"XMPP Chat Client","archived":false,"fork":false,"pushed_at":"2024-08-26T18:27:24.000Z","size":746,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-13T05:18:05.505Z","etag":null,"topics":["chat-client","xmpp"],"latest_commit_sha":null,"homepage":"https://xmpp-chat.netlify.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chamale-rac.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":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-26T02:50:34.000Z","updated_at":"2024-08-27T19:10:58.000Z","dependencies_parsed_at":"2024-08-27T22:02:14.212Z","dependency_job_id":"db2788a6-a3c5-4913-b5d2-c345313b821f","html_url":"https://github.com/chamale-rac/xmpp","commit_stats":null,"previous_names":["chamale-rac/xmpp"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chamale-rac%2Fxmpp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chamale-rac%2Fxmpp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chamale-rac%2Fxmpp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chamale-rac%2Fxmpp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chamale-rac","download_url":"https://codeload.github.com/chamale-rac/xmpp/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247563933,"owners_count":20958971,"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-client","xmpp"],"created_at":"2024-09-26T12:21:16.360Z","updated_at":"2025-04-06T22:47:35.588Z","avatar_url":"https://github.com/chamale-rac.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# XMPP Chat Client\n\nThis project is an XMPP (Extensible Messaging and Presence Protocol) chat client implemented in React. It provides a robust set of features for real-time communication, group chats, file sharing, and more.\n\n![image](https://github.com/user-attachments/assets/c65500ea-deeb-4d28-bf35-6021a25f4bd5)\n\n## Features\n\n### Account Management (20%)\n1. Register a new account on the server\n2. Log in with an existing account\n3. Log out from an account\n4. Delete the account from the server\n\n### Communication (80%)\n1. Display all contacts and their status\n2. Add a user to contacts\n3. Show contact details of a user\n4. One-on-one communication with any user/contact\n5. Participate in group conversations\n6. Set presence message\n7. Send/receive notifications\n8. Send/receive files\n\n## Additional Features\n\n- **Bookmarks**: Bookmark groups for easy access and auto-join\n- **Customizable Groups**: Create public or private groups with custom settings\n- **Real-time Updates**: Live updates for messages, presence, and group changes\n- **Message History**: Retrieve and display message history\n- **Unread Message Counters**: Track unread messages for each conversation\n- **Custom Status Messages**: Set personalized status messages\n- **Profile Pictures**: Support for user profile pictures\n\n## Installation\n\nTo install and run this XMPP client on your local machine, follow these steps:\n\n1. Ensure you have Node.js (version 14 or later) and npm installed on your system.\n\n2. Clone the repository:\n   ```\n   git clone https://github.com/yourusername/xmpp-chat-client.git\n   cd xmpp-chat-client\n   ```\n\n3. Install the dependencies:\n   ```\n   npm install\n   ```\n\n4. Create a `.env` file in the root directory and add your XMPP server configuration:\n   ```\n    VITE_SERVICE=wss://yourserver.com:7443/ws\n    VITE_DOMAIN=yourserver.com\n    VITE_RESOURCE=\n    VITE_MUC_SERVICE=conference.yourserver.com\n    VITE_UPLOAD_SERVICE=httpfileupload.yourserver.com\n   ```\n\n5. Start the development server:\n   ```\n   npm run dev\n   ```\n\n6. Open your browser and navigate to [http://localhost:5173/](http://localhost:5173/) to use the XMPP client.\n\n## Usage\n\n### Account Management\n- **Register**: On the initial screen, provide a username and password, then click \"Register\".\n- **Login**: Enter your credentials and click \"Login\".\n- **Logout**: Click the logout button to end your session and return to the login screen.\n- **Delete Account**: Access account settings to delete your account (use with caution).\n\n### Contacts and Communication\n- **View Contacts**: Your contact list displays all contacts and their current status.\n- **Add Contact**: Click \"Add Contact\" and enter the user's Jabber ID (JID).\n- **Contact Details**: Select a contact to view their details, including subscription status.\n- **One-on-One Chat**: Click on a contact to start a private conversation.\n- **Send Message**: Type your message and press Enter or click the send button.\n\n### Group Chats\n- **Create Group**: Click \"Create Group\", provide a name, and set privacy options.\n- **Join Group**: Use \"Join Group\" and enter the group's JID.\n- **Participate**: Send messages in group chats similar to one-on-one conversations.\n- **Invite Users**: Invite contacts to join your groups.\n\n### Presence and Status\n- **Set Status**: Click on your avatar to open the status menu.\n- **Custom Message**: Set a custom status message to display to your contacts.\n\n### File Sharing\n- **Send File**: In a chat, click the attachment button to select and upload a file.\n- **Receive File**: Incoming files will appear as links in the chat.\n\n### Notifications\n- **Message Alerts**: Receive visual and audio notifications for new messages.\n- **Subscription Requests**: Handle incoming contact requests from the notifications panel.\n\n## Troubleshooting\n\n- If you encounter connection issues, ensure your XMPP server details in the `.env` file are correct.\n- For file upload problems, verify that your XMPP server supports HTTP File Upload (XEP-0363).\n- If messages are not sending, check your internet connection and the XMPP server status.\n\n## Contributing\n\nContributions to this project are welcome. Please fork the repository and submit a pull request with your changes.\n\n## Acknowledgments\n\n- [jakobhoeg](https://github.com/jakobhoeg/shadcn-chat) for the customizable and re-usable chat component used as the base UI.\n- Sound Effect by [Luca Di Alessandro](https://pixabay.com/users/lucadialessandro-25927643/?utm_source=link-attribution\u0026utm_medium=referral\u0026utm_campaign=music\u0026utm_content=180637) from [Pixabay](https://pixabay.com/sound-effects//?utm_source=link-attribution\u0026utm_medium=referral\u0026utm_campaign=music\u0026utm_content=180637) used as notification sound.\n\n## License\n\nThis project is licensed under the MIT License. See the LICENSE file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchamale-rac%2Fxmpp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchamale-rac%2Fxmpp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchamale-rac%2Fxmpp/lists"}