diff --git a/README.md b/README.md index 4396818..b4f9c3c 100644 --- a/README.md +++ b/README.md @@ -1,10 +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/). - -**Want to develop a chatbot using the RASA Framework?? ✏️** [Access Rasa Boiler Plate PTBR](https://github.com/lappis-unb/rasa-ptbr-boilerplate) - +## How to use BotFlow +Instructions available on the [BotFlow website](https://lappis-unb.github.io/BotFlow/) ## Architecture @@ -19,29 +16,6 @@ In [Tais architecture](https://lappis-unb.github.io/tais/documentacao/arquitetur ![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. - - ## Running the application To run application properly you'll have to run the API as well. To do so, clone the [API repository](https://github.com/lappis-unb/botFlowAPI) and run `docker-compose up`. @@ -65,6 +39,11 @@ 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/). + +**Want to develop a chatbot using the RASA Framework?? ✏️** [Access Rasa Boiler Plate PTBR](https://github.com/lappis-unb/rasa-ptbr-boilerplate) + ## License The entire BotFlow platform is developed under the license [GPL3](https://github.com/lappis-unb/BotFlow/blob/master/LICENSE) diff --git a/app/public/add_intent.gif b/app/public/add_intent.gif deleted file mode 100644 index 7772c28..0000000 Binary files a/app/public/add_intent.gif and /dev/null differ diff --git a/app/public/add_story.gif b/app/public/add_story.gif deleted file mode 100644 index 4bce176..0000000 Binary files a/app/public/add_story.gif and /dev/null differ diff --git a/app/public/add_utter.gif b/app/public/add_utter.gif deleted file mode 100644 index 6bc3ee5..0000000 Binary files a/app/public/add_utter.gif and /dev/null differ diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 0000000..c741881 --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1 @@ +theme: jekyll-theme-slate \ No newline at end of file diff --git a/docs/add_intent.gif b/docs/add_intent.gif new file mode 100644 index 0000000..aeecc47 Binary files /dev/null and b/docs/add_intent.gif differ diff --git a/docs/add_story.gif b/docs/add_story.gif new file mode 100644 index 0000000..1f42de0 Binary files /dev/null and b/docs/add_story.gif differ diff --git a/docs/add_utter.gif b/docs/add_utter.gif new file mode 100644 index 0000000..00f1c12 Binary files /dev/null and b/docs/add_utter.gif differ diff --git a/app/public/botflow-architecture.png b/docs/botflow-architecture.png similarity index 100% rename from app/public/botflow-architecture.png rename to docs/botflow-architecture.png diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..a7726d1 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,27 @@ +## 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. + +![](./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. + +![](./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. + +![](./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. + +## 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) \ No newline at end of file