Skip to content

Commit

Permalink
added readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Adrian Ariton authored and Adrian Ariton committed Nov 15, 2023
1 parent 6876592 commit 8b0005c
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions book/chattutor_setup/README.md
Original file line number Diff line number Diff line change
@@ -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
```

0 comments on commit 8b0005c

Please sign in to comment.