Setup for development#
This page provides information on how to set up Maestro for development. For using Maestro as a library in an app, see Getting started.
Set up with devcontainer#
To set up for development, use the provided devcontainer in VSCode. Choose “Remote-Containers: Reopen in Container” in VSCode when prompted (or use the command palette). This will set up a development environment with all necessary dependencies.
Set up without devcontainer#
If you don’t want to use devcontainer, follow these steps:
Set up and activate virtualenv:
cd maestro python -m venv .venv source .venv/bin/activate pip install poetry poetry install
Launch Docker Compose:
docker compose up
Install NATS CLI
Setup Maestro as a standalone service#
Maestro can be setup as a standalone service with Docker and Docker Compose:
Clone the Maestro repository to your local machine
Configure as needed:
Environment variables in the
config/
directorydocker-compose.yml
file
Build using Docker Compose (from root):
docker compose build
Start the Maestro services:
docker compose up
Alternatively, you can install Maestro locally using pip:
Install with pip:
pip install src/
Compile tailwind CSS for UI:
maestro-post-install
Access to services#
When services are up and running after setup, you can access (with default configuration):
Maestro UI at http://localhost:8002/
Maestro API at http://localhost:8002/docs
Neo4j browser at http://localhost:47474/browser/