Merge pull request #81 from deeppavlov/dev

release: v0.2.0 final

.github/workflows/build_and_publish_docs.yml

@@ -0,0 +1,43 @@
+name: build_and_publish_docs
+
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  publish:
+    name: build and publish docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: set up python 3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.9
+
+      - name: setup poetry
+        run: |
+          python -m pip install --upgrade pip poetry
+
+      - name: install dependencies
+        run: poetry install
+
+      - name: build documentation
+        run: poetry run make -C docs html
+
+      - name: remove jekyll theming
+        run: touch docs/_build/html/.nojekyll
+
+      - name: deploy website
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          branch: gh-pages
+          folder: docs/_build/html
+          single-commit: True

Makefile

@@ -151,6 +151,11 @@ init_proj: install_backend_env ## Initiates a new project using chatsky-ui
 	cd ${BACKEND_DIR} && poetry run chatsky.ui init --destination ../
 
 
+.PHONY: init_with_cc
+init_with_cc: ## Initiates a new project using cookiecutter
+	cookiecutter https://github.com/Ramimashkouk/df_d_template.git
+
+
 .PHONY: build_docs
 build_docs: install_backend_env ## Builds the docs
 	cd ${BACKEND_DIR} && \

README.md

@@ -1,6 +1,6 @@
 # Quick Start
 ## System Requirements
-Ensure you have Python version 3.8 or higher installed.
+Ensure you have Python version 3.8.1 or higher installed.
 
 ## Installation
 To install the necessary package, run the following command:
@@ -13,7 +13,7 @@ You may add a `.env` file in the root directory and configure any of following e
 ```.env
 HOST=0.0.0.0
 PORT=8000
-CONF_RELOAD=True
+CONF_RELOAD=False
 LOG_LEVEL=info
 
 GRACEFUL_TERMINATION_TIMEOUT=2  # Waiting for process to stop
@@ -25,14 +25,19 @@ RUN_RUNNING_TIMEOUT=5
 ```
 
 ## 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 run your project, use the following command:
+To start your project, use the following command:
 ```bash
-chatsky.ui run_app --project-dir <PROJECT-SLUG>  # enter the slug you choose for your project with the help of the previous command
+chatsky.ui run_app --project-dir <PROJECT-SLUG>  # Replace <PROJECT-SLUG> with the slug you specified during initialization
 ```
+
+## Documentation
+You can refer to the [documentaion](https://deeppavlov.github.io/chatsky-ui/) to dig into the application code understanding.

backend/pyproject.toml

@@ -28,8 +28,8 @@ pytest-mock = "^3.14.0"
 httpx = "^0.27.0"
 httpx-ws = "^0.6.0"
 pylint = "^3.2.3"
-sphinx = { version = "*", python = "^3.10"}
-sphinx-rtd-theme = { version = "*", python = "^3.10"}
+sphinx = "*"
+sphinx-rtd-theme = "*"
 
 [tool.poetry.scripts]
 "chatsky.ui" = "chatsky_ui.cli:cli"

frontend/cypress.config.ts

@@ -2,7 +2,7 @@ import { defineConfig } from "cypress";
 
 export default defineConfig({
   e2e: {
-    setupNodeEvents(on, config) {
+    setupNodeEvents() {
       // implement node event listeners here
     },
   },

frontend/package.json

@@ -39,6 +39,7 @@
     "@uiw/codemirror-theme-andromeda": "^4.21.25",
     "@uiw/codemirror-theme-noctis-lilac": "^4.21.25",
     "@uiw/react-codemirror": "^4.21.25",
+    "@xyflow/react": "^12.2.0",
     "axios": "^1.6.7",
     "babel-jest": "^29.7.0",
     "classnames": "^2.5.1",
@@ -60,7 +61,6 @@
     "react-router-dom": "^6.22.2",
     "react-test-renderer": "^18.3.1",
     "react-xarrows": "^2.0.2",
-    "reactflow": "^11.10.4",
     "ts-jest": "^29.1.2",
     "ts-node": "^10.9.2",
     "uuid": "^9.0.1",

frontend/src/App.tsx

@@ -1,6 +1,6 @@
 import { NextUIProvider } from "@nextui-org/react"
+import { ReactFlowProvider } from "@xyflow/react"
 import { RouterProvider, createBrowserRouter } from "react-router-dom"
-import { ReactFlowProvider } from "reactflow"
 import { Preloader } from "./UI/Preloader/Preloader"
 import ContextWrapper from "./contexts"
 import { UndoRedoProvider } from "./contexts/undoRedoContext"