Metadata-Version: 2.1
Name: reflex-rxchat
Version: 0.2.2
Summary: Drop in self hosted chat for reflex.dev
License: GPL
Author: Albert Sola
Author-email: albert.sola@gmail.com
Requires-Python: >=3.12,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: aiohttp
Requires-Dist: reflex (>=0.6.6)
Description-Content-Type: text/markdown

# Reflex Chat (rxchat)
[![Tests](https://github.com/albertsola/rxchat/actions/workflows/tests.yml/badge.svg)](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.

![RxChat preview](preview.png "RxChat preview")

## 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]

```

