https://github.com/deeppavlov/chatsky-ui
Dialog Flow Designer is GUI for Dialog Flow Framework, that is a free and open-source software stack for creating chatbots, released under the terms of Apache License 2.0.
https://github.com/deeppavlov/chatsky-ui
Last synced: over 1 year ago
JSON representation
Dialog Flow Designer is GUI for Dialog Flow Framework, that is a free and open-source software stack for creating chatbots, released under the terms of Apache License 2.0.
- Host: GitHub
- URL: https://github.com/deeppavlov/chatsky-ui
- Owner: deeppavlov
- License: apache-2.0
- Created: 2023-12-01T07:56:39.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-04-18T11:40:10.000Z (over 1 year ago)
- Last Synced: 2025-04-18T21:33:06.046Z (over 1 year ago)
- Language: TypeScript
- Size: 14.4 MB
- Stars: 4
- Watchers: 6
- Forks: 4
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Quick Start
## System Requirements
Ensure you have Python version 3.9 or higher installed (Excluding 3.9.7).
## Installation
To install the package and necessary dependencies, run the following command:
```bash
pip install chatsky-ui
```
## Project Initiation
💡 You are encouraged to run `chatsky.ui --help` to explore the available CLI options.
Initialize your project by running:
```bash
chatsky.ui init
```
The `chatsky.ui init` command will start an interactive `cookiecutter` process to create a project based on a predefined template. The resulting project will be a simple example template that you can customize to suit your needs.
## Running Your Project
To start your project, use the following command:
```bash
chatsky.ui run_app --project-dir # Replace with the slug you specified during initialization
```
## Configuring the chatsky-ui app
You may add a `.env` file in the root directory and configure any of following environment variables. The values shown below are the default ones.
```.env
HOST=0.0.0.0
PORT=8000
CONF_RELOAD=False
LOG_LEVEL=info
GRACEFUL_TERMINATION_TIMEOUT=2 # Waiting for process to stop
PING_PONG_TIMEOUT=0.5 # Waiting the process to response before it mark it as still `running`
# For tests:
BUILD_COMPLETION_TIMEOUT=10
RUN_RUNNING_TIMEOUT=5
```
## Documentation
You can refer to the [documentaion](https://deeppavlov.github.io/chatsky-ui/) to dig into the application code understanding.