paint-yourself-api

API for the Paint Yourself mobile application

Getting Started

Prerequisites

You will need to have installed:

1. Python v3.9 or greater
2. Poetry v1.1 or greater

Running for development

1. Clone the repo.

   git clone https://github.com/TCDPaintYourself/paint-yourself-api

2. Navigate into the cloned GitHub repository.

   cd paint-yourself-api

3. Install the dependencies.

   poetry install

   OR

   pip install -r requirements.txt

   And skip to last step.

4. Activate the python virtual environment.

   poetry shell

5. Run the server.

   uvicorn paint_yourself_api.main:app --reload --host 0.0.0.0 --port 8080

   Alternatively, if you are using VSCode, you can use f5 to launch a debug session (ensure that you have set up the poetry python environment).

The API will be deployed locally at http://localhost:8080 and the API documentation can be found at http://localhost:8080/docs.