NeonGeckoCom / pyklatchat

Pythonic Version of Klatchat
Other
2 stars 0 forks source link

PyKlatchat

PyKlatchat is a pythonic version of klatchat that is developed to make existing solution more modular and extendable.

White Paper

An actual description of proposed solution can be found under this link.

Configuration

Any configuration properties should be grouped by runtime environment which is set via environment variable "KLAT_ENV"

Database

For database configuration location is managed via environment variable "DATABASE_CONFIG".

Note: database configuration can be merged inside other configurations (e.g. chat server configuration file) the only strong requirement is a key header "DATABASE_CONFIG"

Example of configuration

Example of configuration can be found in "example_db_config.json"

Chat Server

Chat server configuration location is managed via environment variable "CHATSERVER_CONFIG".

Example of configuration

Example of configuration can be found in "chat_server/example_server_config.json"

Launching

Chat Server can be launched as python module from root directory: python -m chat_server

Chat Client

Chat client configuration location is managed via environment variable "CHATCLIENT_CONFIG"

Client-side configuration

Client side configuration is used to determine Javascript configs, it should be named "runtime_config.json" and placed to "chat_client/static/js"

Example can be found in "chat_client/static/js/example_runtime_config.json"

Server-side configuration

Example of configuration can be found in "chat_client/example_client_config.json"

Launching

Chat Client can be launched as python module from root directory: python -m chat_client