Skip to content

Psynapse Quick Start Guide

🚀 Get Started in 2 Ways

The fastest way to get Psynapse running:

git clone https://github.com/soumik12345/psynapse
cd psynapse
docker compose -f docker/docker-compose.yml up --build

Access the editor at http://localhost:5173

Optional: With LLM Support

To enable LLM nodepacks (requires additional dependencies):

OPTIONAL_DEPS=llm docker compose -f docker/docker-compose.yml up --build

Option 2: Local Development

For development and customization:

Step 1: Clone and Install

git clone https://github.com/soumik12345/psynapse
cd psynapse

Step 2: Start the Backend

uv sync
psynapse-backend run --reload

You should see: 

INFO:     Started server process
INFO:     Uvicorn running on http://0.0.0.0:8000

Optional: Install with LLM support

uv sync --extra llm

Step 3: Start the Frontend

Open another terminal and run:

cd frontend
npm install
npm run dev

You should see: 

VITE ready in XXX ms
➜  Local:   http://localhost:5173/

Step 4: Open Your Browser

Navigate to: http://localhost:5173

🎯 First Workflow

Create your first workflow in 30 seconds:

  1. Drag an "add" node from the left panel onto the canvas
  2. Enter values in the node: a=10, b=5
  3. Drag a "ViewNode" onto the canvas
  4. Connect the output (right side) of the add node to the input (left side) of the ViewNode
  5. Click "Execute" button (top-right)
  6. See the result: ViewNode shows 15

📝 Tips

  • Connect nodes: Drag from output socket (right) to input socket (left)
  • Input values: Type directly or connect from another node
  • Multiple ViewNodes: Add multiple ViewNodes to inspect different parts of your workflow
  • Minimap: Use the minimap (bottom-right) to navigate large workflows
  • Canvas controls: Scroll to zoom, drag to pan

🧪 Example: Calculator

Create (5 + 3) × (2 + 4) = 48:

  1. Drag 2 "add" nodes onto canvas
  2. First add: a=5, b=3
  3. Second add: a=2, b=4
  4. Drag 1 "multiply" node onto canvas
  5. Connect:
  6. First add output → multiply's a input
  7. Second add output → multiply's b input
  8. Drag ViewNode and connect multiply output to it
  9. Click Execute
  10. Result: 48

🔧 Troubleshooting

Backend won't start

cd backend
uv venv
source .venv/bin/activate
uv pip install -r requirements.txt
uv run python main.py

Frontend won't start

cd frontend
npm install
npm run dev