Skip to content

Commit

Permalink
reformat README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kirgrim committed Apr 14, 2024
1 parent 6355e68 commit 751ae2c
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,46 +11,46 @@ An actual description of proposed solution can be found [under this link](https:
Any configuration properties should be grouped by runtime environment which is set via environment variable "<b>KLAT_ENV</b>"


### Database
## Database

For database configuration location is managed via environment variable "<b>DATABASE_CONFIG</b>".

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

#### Example of configuration
### Example of configuration

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


### Chat Server
## Chat Server

Chat server configuration location is managed via environment variable "<b>CHATSERVER_CONFIG</b>".

#### Example of configuration
### Example of configuration

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

#### Launching
### Launching

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

### Chat Client
## Chat Client

Chat client configuration location is managed via environment variable "<b>CHATCLIENT_CONFIG</b>"

#### Client-side configuration
### 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
### Server-side configuration

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

#### Launching
### Launching

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

0 comments on commit 751ae2c

Please sign in to comment.