From 8b0005cab382f3f89872bfe3537925ff5fa6dcda Mon Sep 17 00:00:00 2001 From: Adrian Ariton Date: Wed, 15 Nov 2023 23:23:43 +0200 Subject: [PATCH] added readme --- book/chattutor_setup/README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 book/chattutor_setup/README.md diff --git a/book/chattutor_setup/README.md b/book/chattutor_setup/README.md new file mode 100644 index 0000000..7d022b1 --- /dev/null +++ b/book/chattutor_setup/README.md @@ -0,0 +1,23 @@ +# Building + +From the root folder of the app run: +```sh +jupyter-book build --all book +python3 ./book/chattutor_setup/install.py # adding the chattutor script to all the html files +``` + +CORS needs to allow the url to make requests!! +For now this can only be tested locally. + +# Testing locally + +Checkout chattutor.config.js + +- Start an instance of the main branch at port `5000` at `localhost` +- Go to config and set **TEST_MODE** to true and **SERVER_PORT** to `5000` +- Run the following commands to build the notebook and to add chattutor +one in venv (checkout main README for info on that) +```sh +jupyter-book build --all book +python3 ./book/chattutor_setup/install.py # adding the chattutor script to all the html files +``` \ No newline at end of file