From 8529c2fc4f4c19c42f8efeaa52a38e6749a29223 Mon Sep 17 00:00:00 2001 From: Rossdan Craig <151060367+rossdanlm@users.noreply.github.com> Date: Fri, 29 Dec 2023 18:05:21 -0500 Subject: [PATCH] Update README.md Add command to clear node_modules for dev --- python/src/aiconfig/editor/README.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/python/src/aiconfig/editor/README.md b/python/src/aiconfig/editor/README.md index a57c532df..91c55faaa 100644 --- a/python/src/aiconfig/editor/README.md +++ b/python/src/aiconfig/editor/README.md @@ -57,20 +57,28 @@ e.g. `aiconfig edit --parsers-module-path="/path/to/my_editor_plugin.py"` ### Install: -`pip install -e path/to/local/aiconfig/python` - -`alias aiconfig="python -m 'aiconfig.scripts.aiconfig_cli'"` +From the top-level `aiconfig` dir: +```bash +pip3 install -e aiconfig/python +alias aiconfig="python -m 'aiconfig.scripts.aiconfig_cli'" +``` ### Run backend and frontend servers: - -(debug mode will run the react server) -`aiconfig edit --aiconfig-path=/my/path --server-port=8080 --server-mode=debug_servers` +Replace the `aiconfig_path` variable with the path to your AIConfig file. +For example: `cookbooks/Getting-Started/travel.aiconfig.json` +```bash +rm -rf aiconfig/python/src/aiconfig/editor/client/node_modules +aiconfig_path="cookbooks/Getting-Started/travel.aiconfig.json" + +# Use debug mode to run the frontend react server +aiconfig edit --aiconfig-path=$aiconfig_path --server-port=8080 --server-mode=debug_servers +``` More info: `aiconfig --help` `aiconfig edit --help` -### Frontent +### Frontend Use React server localhost:3000