# Reflex Chat (rxchat)
[](https://github.com/albertsola/rxchat/actions/workflows/tests.yml)
Reflex Chat (rxchat) is a versatile and efficient chat interface designed to seamlessly integrate into Reflex projects. Built with the Reflex framework for the frontend and FastAPI for the backend, rxchat offers developers a ready-to-use chat solution that combines simplicity, flexibility, and performance.
## Features
- **Frontend Integration**: Easily integrates with Reflex-based projects for a smooth UI experience.
- **Backend Support**: Powered by FastAPI for fast, reliable, and scalable backend operations.
- **Customizable**: Modify and extend the chat interface to suit your specific needs.
- **Real-Time Communication**: Support for real-time messaging using WebSockets.
## Getting Started
### Prerequisites
Ensure you have the following installed:
- Python 3.13
- poetry
### Installation
1. Clone the repository:
```bash
git clone https://github.com/albertsola/rxchat.git
cd rxchat
```
2. Install Python dependencies:
```bash
poetry install
poetry run reflex init
```
3. Run the project:
```bash
poetry run reflex run
```
5. Project running:
App running at: http://localhost:3000
Backend running at: http://0.0.0.0:8000/api/docs
### Testing
```
poetry run tox # Checks everything
poetry run flake8
poetry run mypy
poetry run pytest --cov
poetry run black [file or a folder]
```
Raw data
{
"_id": null,
"home_page": null,
"name": "reflex-rxchat",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "reflex, reflex-custom-components",
"author": null,
"author_email": "Albert Sola <albert.sola@tardix.net>",
"download_url": "https://files.pythonhosted.org/packages/49/f6/e096f6446953e4628811bf5097f2c42dde58bcb914f27a3928cd3c409e0a/reflex_rxchat-0.2.3.tar.gz",
"platform": null,
"description": "# Reflex Chat (rxchat)\n[](https://github.com/albertsola/rxchat/actions/workflows/tests.yml)\n\nReflex Chat (rxchat) is a versatile and efficient chat interface designed to seamlessly integrate into Reflex projects. Built with the Reflex framework for the frontend and FastAPI for the backend, rxchat offers developers a ready-to-use chat solution that combines simplicity, flexibility, and performance.\n\n![RxChat preview](preview.png \"RxChat preview\")\n\n## Features\n\n- **Frontend Integration**: Easily integrates with Reflex-based projects for a smooth UI experience.\n- **Backend Support**: Powered by FastAPI for fast, reliable, and scalable backend operations.\n- **Customizable**: Modify and extend the chat interface to suit your specific needs.\n- **Real-Time Communication**: Support for real-time messaging using WebSockets.\n\n## Getting Started\n\n### Prerequisites\n\nEnsure you have the following installed:\n- Python 3.13\n- poetry\n\n### Installation\n\n1. Clone the repository:\n ```bash\n git clone https://github.com/albertsola/rxchat.git\n cd rxchat\n ```\n\n2. Install Python dependencies:\n ```bash\n poetry install\n poetry run reflex init\n ```\n3. Run the project:\n ```bash\n poetry run reflex run\n ```\n\n5. Project running:\n App running at: http://localhost:3000\n Backend running at: http://0.0.0.0:8000/api/docs\n\n\n### Testing\n\n```\npoetry run tox # Checks everything\n\npoetry run flake8\n\npoetry run mypy\n\npoetry run pytest --cov\n\npoetry run black [file or a folder]\n\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Local chat for Reflex applications",
"version": "0.2.3",
"project_urls": {
"Homepage": "https://github.com/albertsola/rxchat"
},
"split_keywords": [
"reflex",
" reflex-custom-components"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ac8bad3ab8e6ccab8eb8386f1277d878b79a2cec4dd1106aff158cf7428feead",
"md5": "52035c8e44172d7229d3ad4136a92c1d",
"sha256": "f13f1c0943821c37d59b98bbc858c07c76d292b6e33a582d66585abe7f43e02e"
},
"downloads": -1,
"filename": "reflex_rxchat-0.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "52035c8e44172d7229d3ad4136a92c1d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 14201,
"upload_time": "2024-12-20T13:22:40",
"upload_time_iso_8601": "2024-12-20T13:22:40.643404Z",
"url": "https://files.pythonhosted.org/packages/ac/8b/ad3ab8e6ccab8eb8386f1277d878b79a2cec4dd1106aff158cf7428feead/reflex_rxchat-0.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "49f6e096f6446953e4628811bf5097f2c42dde58bcb914f27a3928cd3c409e0a",
"md5": "bd21e61aacd38cc810cc7d6ad39c0c0d",
"sha256": "5808941f33a7b664e4066aa4b744e16c741e7f2682f32b889cb8ba082dbc6fdb"
},
"downloads": -1,
"filename": "reflex_rxchat-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "bd21e61aacd38cc810cc7d6ad39c0c0d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 11069,
"upload_time": "2024-12-20T13:22:41",
"upload_time_iso_8601": "2024-12-20T13:22:41.913671Z",
"url": "https://files.pythonhosted.org/packages/49/f6/e096f6446953e4628811bf5097f2c42dde58bcb914f27a3928cd3c409e0a/reflex_rxchat-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-20 13:22:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "albertsola",
"github_project": "rxchat",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "reflex-rxchat"
}
JSON
