zPod Core

zPodFactory Core Engine

DEVELOPMENT ENVIRONMENT SETUP

Complete the following steps to set up your development environment:

1. Install Docker and Docker Compose

2. Install pyenv and add 3.12.1

   brew install pyenv
   pyenv install 3.12.1

3. Install Poetry:

   pip install poetry

4. Configure Virtual Environment. In the /zpodapi, /zpodengine and /zpodcli directories, run:

   pyenv local 3.12.1
   poetry config virtualenvs.in-project true
   poetry install

5. Configure Environment Variables. (See /zpodapi/src/zpodapi/lib/settings.py file for all available settings) In the root directory, run:

   cp .env.default .env
   vim .env

6. For Visual Studios Code, do the following:

   a. Configure the zpodcore.code-workspace. In / run:

   cp zpodcore.code-workspace.default zpodcore.code-workspace

   Make sure that the port variable in launch.configurations.connect.port matches the port stored in the ZPODAPI_DEBUG_HOSTPORT environment variable.

7. Build the Docker containers. In the root directory, run:

   docker compose build

8. Start the environment. In the root directory, run:

   just zpodcore-start

9. Verify that zpodapi is working by opening a browser and going to http://localhost:[8000 or ZPODAPI_HOSTPORT] and http://localhost:[8000 or ZPODAPI_HOSTPORT]/docs

10. Create Deployments

    just zpodengine-deploy-all