redis-streams-fastapi-chat - GitLite

KO | EN

gitlite — search

#javascript #python #react #typescript #llm #rust #linux #docker #macos #java #awesome #pytorch #security #ios

redis-streams-fastapi-chat

(★ 354)

A simple Redis Streams backed Chat app using Websockets, Asyncio and FastAPI/Starlette.

File Explorer

Download Latest Version (.zip)

- - codeql-analysis.yml
- chat.html
- moderator_chat.html
.gitignore
__init__.py
artillery_test.yml
chat.py
docker-compose.yml
Dockerfile
LICENSE
README.md
requirements.txt
SECURITY.md

# Installation Guide

1. Get the code

git clone https://github.com/leonh/redis-streams-fastapi-chat

Downloads the entire project code from GitHub to your computer.

cd redis-streams-fastapi-chat

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

$ docker-compose up

Runs the command against the services defined in the compose file.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

$ pip install -r requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

✅ If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# redis-streams-fastapi-chat
A simple demo of Redis Streams backed Chat app using Websockets, Python Asyncio and FastAPI/Starlette.

Requires Python version >= 3.11 and Redis 7+

# Overview
This project has been created to help understand some related concepts. Python standard library asyncio, websockets (which are often cited as a classic use case for async python code), also Redis Streams. It is very much inteded to be an intentionally simple starting point rather than a usable product as is.

# Installation

## Local Development

```shell
$ pip install -r requirements.txt
```

Make sure you have Redis running locally:
```shell
$ redis-server
```

# Usage

## Local Development

```shell
$ python chat.py
```

Then open http://localhost:9080 in your browser.

## Docker Compose

The easiest way to run the application with all dependencies:

```shell
$ docker-compose up
```

This will start both the chat application and Redis in containers. The app will be available at http://localhost:9080

## Environment Variables

The following environment variables can be configured:

- `REDIS_HOST` - Redis server hostname (default: `localhost`, set to `redis` in Docker)
- `REDIS_PORT` - Redis server port (default: `6379`)