Commit 373d1140 authored by Ute Trapp's avatar Ute Trapp
Browse files

Merge branch 'docs/add_pycharm_run_configuration_instructions' into 'master'

- [docs] Added instructions for local PyCharm run configuration

See merge request !1
parents b5b521e8 5312aa3e
......@@ -32,6 +32,15 @@ From the command shell as admin in the folder nlp run
```
uvicorn app.nlp_server:app --reload
```
Alternatively you can add a run configuration in PyCharm to have the debugger attached:
1. Click "Add configuration" in the top right corner
2. Add a new Python configuration by clicking on the "+" at the top left
3. Give your run configuration an appropriate name like "FastAPI"
4. In the configuration tab click the first dropdown and select "Module name"
5. Enter `uvicorn` as module name
6. Add `app.nlp_server:app --reload` to the parameters
7. Save your configuration and enjoy hot reload and an attached debugger
The server will be reloaded after editing any file. Check it with http://127.0.0.1:8000/ which should return *nlp server is available*.
The OpenAPI doc is available under http://127.0.0.1:8000/docs
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment