Development Setup
Prerequisites
- Python 3.12
- Poetry (For installation please refer to Poetry Installation (opens in a new tab))
- Temporal CLI (For installation please refer to Temporal CLI Installation (opens in a new tab))
- Node.js 20 (For installation please refer to Node.js Installation (opens in a new tab))
- pnpm (For installation please refer to pnpm Installation (opens in a new tab))
Setup
git clone git@github.com:Admyral-Security/admyral.git
cd admyral
# Install dependencies
poetry install
# Install githook scripts
pre-commit installEnvironment Variable
cp .env.example .env
# activate the environment variables (Tip: use a tool, such as autoenv or autodir, for
# automatically sourcing the environment variables)
source .envTo enable the AI action and send email action, you must set an OpenAI and
Resend API key in the .env file.
Temporal
Start the Temporal development server:
temporal server start-devAPI Backend
poetry run python admyral/main.py apiWorkflow Worker
poetry run python admyral/main.py workerWeb
# 1. Go to the `web` directory and install the dependencies:
cd web
pnpm i
# 2. Start the development server:
pnpm devDocumentation
# 1. Go to the `docs` directory and install the dependencies:
cd docs
pnpm i
# 2. Start the development server:
pnpm dev