Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
D-Hemanth committed Jul 30, 2023
1 parent 8280958 commit d571977
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 5 deletions.
44 changes: 39 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,42 @@
# React + Vite
# Chatbot Flow Builder

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
## Live Demo: https://chatbot-flow-builder-beryl.vercel.app/

Currently, two official plugins are available:
This Chatbot flow builder template provides a minimal setup to get up & running with a flow builder for creating & connecting multiple message nodes together to decide the order of execution.

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
Made with [React](http://reactjs.org) and [React Flow](https://reactflow.dev/).

Demo Images:
![Demo](./public/images/demo.png)
![Demo 1](./public/images/demo1.png)
![Demo 2](./public/images/demo2.png)

Currently, the following features are available:

- Our flow builder currently supports only one type of message (i.e Text Message) inside the Nodes panel but it is extensible.
- Source Handle connections are limited to one connection to make it easy to decide the order of execution of flow builder.
- Unlimited number of connections to the target Handle.
- Settings Panel will replace the Nodes Panel when a Node is selected. It has a text field to edit text of the selected Text Node.
- Currently we support only Dark Mode.

## Available Scripts

In the project directory, you can run:

### `npm start`

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will reload when you make changes.\
You may also see any lint errors in the console.

### `npm run build`

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
Binary file added public/images/demo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/demo1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/demo2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d571977

Please sign in to comment.