README.md

Sandbox

This folder contains a sandbox API for initial development

For more information about building sandbox APIs see the API Producer Zone confluence.

Table of Contents

• Sandbox
  • Table of Contents
  • Prerequisites
  • Quick Start
    • Installing dependencies
    • Starting the API
  • Development
    • Starting the API with Hot Reloading
    • Testing
      • Unit Tests
    • Useful commands

Prerequisites

• Python 3.8
• Poetry
• Docker

Quick Start

Please note all commands are meant to be run from this directory /sandbox

Installing dependencies

To install the dependencies use make install

If you do not have poetry installed you can install the dependencies using pip install poetry and then run make install

Starting the API

To start the API locally use make start

Development

Please note all commands are meant to be run from this directory /sandbox

Starting the API with Hot Reloading

To run the API with hot reloading use make start-dev

Testing

Unit Tests

Unit tests can be run using make test

Useful commands

For more useful development commands review the Makefile or run make list