Skip to content

Commit

Permalink
added restart to list of api commands
Browse files Browse the repository at this point in the history
  • Loading branch information
benne238 committed May 18, 2021
1 parent 82b7e95 commit c78973c
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/Dev Environment Setup Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -271,5 +271,6 @@ There are two main tools for development, mkdocs is used for viewing and buildin
| - | - |
| `python3 -m webqueue2_api start-api` | This will start a local WSGI server on [localhost:5000](http://localhost:5000) to access the API. You can interact with the API using `curl` or [Postman](https://www.postman.com/) |
| `python3 -m webqueue2_api stop-api` | Kills the runaway API process(es). |
| `python3 -m webqueue2_api restart-api` | Runs `python3 -m webqueue2_api stop-api` then `python3 -m webqueue2_api start-api` |
| `mkdocs serve` | This will start a local server on [localhost:8000](http://localhost:8000) to access the API docs. As you change API documentation files in `api/documentation/docs` you'll see your changes in the browser. |
| `mkdocs build` | This will output a static bundle of the API documentation in `webqueue2-api/site` that can be put on any webserver. |

0 comments on commit c78973c

Please sign in to comment.