Skip to content
This repository has been archived by the owner on Oct 11, 2022. It is now read-only.

Gorgeous-Ghouls/Blak

Repository files navigation

Blak

The Remarkable Place to Prattle, Ever

Blak is a cross-platform, FastAPI-powered, Websocket based Chat Application, made for Python-Discord's Summer Code Jam 9.

Features

  • Blak is for people who need to chat in private.
  • Blak has no word wrap. So even if someone sends humongous text messages, It won't be visible. So, users can have a meaningful talk within a few messages.
  • Users can see each others typing-in messages in real-time.

Tech

Blak uses a number of open source projects to work properly:

  • Kivy - Amazing open source UI framework written in Python
  • FastAPI - Awesome web framework for buildingAPIs with Python
  • Websockets - Library for building WebSocket servers and clients in Python.
  • Poetry - Great pacakage manager for Python

And of course Blak itself is open source with a public repository on GitHub.

Installation:

Blak requires Python 3.10 to run.

Clone the repo, install the requirements using Poetry for the client and start the app (server has been already implemented and running, so we can skip to the following part)

git clone https://github.com/Gorgeous-Ghouls/Blak.git
cd client
poetry install
poetry run blak

Run with your own server:

Install requirements, and start the server

cd server
poetry install
poetry run blak-server

And in the client/.env file, change and replace url:port to server's running url:port

WEBSOCKET_HOST=<ip or url:port>

Docker

Run the server with docker

docker run -p 8001:8000 -d ghcr.io/gorgeous-ghouls/blak/blak-server

License

MIT