Skip to content

Commit

Permalink
Correct and simplify API commands
Browse files Browse the repository at this point in the history
  • Loading branch information
campb303 committed May 18, 2021
1 parent 485de8a commit 1fddf8e
Showing 1 changed file with 5 additions and 8 deletions.
13 changes: 5 additions & 8 deletions docs/Dev Environment Setup Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -289,14 +289,11 @@ webqueue2 API has multiple [conditional dependencies](https://setuptools.readthe
| Documentation | `pip install webqueue2-api[docs]` | For use in creating documentation. Installs everything for production and extra packages for documentation. |
| All | `pip install webqueue2-api[all]` | A shortcut for installing production, development and documentation dependencies. |

## Using the dev Tools
There are two main tools for development, mkdocs is used for viewing and building documentation while webqueue2-api is used for running the api and testing changes made to the code.

### API Commands
| Command | Description |
| - | - |
| `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. |
| `python3 -m webqueue2_api start-api` | Starts the API on [localhost:5000](http://localhost:5000). See [Getting Started](./api/Getting Started.md) for more info. |
| `python3 -m webqueue2_api stop-api` | Stops the API. |
| `python3 -m webqueue2_api restart-api` | Stops and starts the 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 `./docs/` you'll see your changes in the browser. |
| `mkdocs build` | This will output a static bundle of the API documentation in `./site/` that can be put on any webserver. |

0 comments on commit 1fddf8e

Please sign in to comment.