Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove large images #160

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 6 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# BotFlow - visual content manager for simple [Rasa](https://blog.rasa.com/) chatbots

## About the project
BotFlow was originally created by [LAPPIS](https://lappis.rocks) as part of a project done in partnership with the Brazilian Ministry of Citizenship to manage the content of [Tais](https://github.com/lappis-unb/tais), a chatbot for the [culture incentive law](http://leideincentivoacultura.cultura.gov.br/).
## How to use BotFlow
Instructions available on the [BotFlow website](https://lappis-unb.github.io/BotFlow/)

**Want to develop a chatbot using the RASA Framework?? ✏️** [Access Rasa Boiler Plate PTBR](https://github.com/lappis-unb/rasa-ptbr-boilerplate)

Expand All @@ -17,30 +17,7 @@ The frontend is divided in Pages, Components and Ducks:

In [Tais architecture](https://lappis-unb.github.io/tais/documentacao/arquitetura/), this platform generates the training data.

![image](app/public/botflow-architecture.png)

## How does it work?
Botflow allows you to add and edit intents, utters and stories without handling markdown or yaml files.

### Intents
To add the intents, just go to the Questions page and add examples of user's inputs to that intent. You can also edit or delete a intent by selecting it on the sidebar.

![](./app/public/add_intent.gif)

### Utters
To add utters, just go to the Answers page and add your bot's answer. You can edit or delete a existing utter as well, just select it on the sidebar. The utters may be displayed as sequence or chosed between alternatives.

![](./app/public/add_utter.gif)

### Stories
A Story is a sequence of intents and utters. To create one, go to Dialogs page and select an existing story or create a new one. You can drag the elements to place it in the correct order. See an example of conversation on the right side of the screen.

![](./app/public/add_story.gif)

### Save Content

After all content is ready, click on the Export Content button on the Navbar and it will download the created content.

![image](https://lappis-unb.github.io/BotFlow/botflow-architecture.png)

## Running the application

Expand All @@ -65,6 +42,9 @@ After all API configuration is done, to run the application just run the `docker
npm test -- --coverage --watchAll=false
```

## About the project
BotFlow was originally created by [LAPPIS](https://lappis.rocks) as part of a project done in partnership with the Brazilian Ministry of Citizenship to manage the content of [Tais](https://github.com/lappis-unb/tais), a chatbot for the [culture incentive law](http://leideincentivoacultura.cultura.gov.br/).

## License
The entire BotFlow platform is developed under the license [GPL3](https://github.com/lappis-unb/BotFlow/blob/master/LICENSE)

Expand Down
Binary file removed app/public/add_intent.gif
Binary file not shown.
Binary file removed app/public/add_story.gif
Binary file not shown.
Binary file removed app/public/add_utter.gif
Binary file not shown.
Binary file removed app/public/botflow-architecture.png
Binary file not shown.