diff --git a/README.md b/README.md index c515f2f08a400b0943263711e4e01f4610928ca1..aebd4b7d8b6759955f4c0cbd6ce82f5a498d51a1 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ This project is based on a swagger-enabled Flask server using an *API First* app Python 3.7+ MariaDB (or similar Database) -# Setup +## Installation Install the required dependencies: @@ -21,39 +21,39 @@ pip3 install -r requirements.txt pip3 install -r contrib/mariadb-requirements.txt # Create database and user (change password in script) sudo mysql -u root -p < contrib/mariadb-database.sql - - ``` + ## Getting started To run the server, please execute the following from the root directory: -``` +```bash ./run.sh api ``` To run the API in an local development server execute: -``` +```bash ./run.sh api-dev ``` You can access the interactive documentation here: -``` +```bash http://localhost:8008/api/v1/ui/ ``` Your OpenAPI definition lives here: -``` +```bash http://localhost:8008/api/v1/openapi.json ``` ## Testing To launch the integration tests, use tox: -``` + +```bash sudo pip install tox ./run.sh test ```