Home / Documentation / Getting Started

Installation Guide

Requirements

  • Python 3.10+ (the project's own venv is recommended; on Windows it is .venv)
  • Node.js 18+ (frontend)
  • SQLite 3 (FTS5 full-text search included)
  • At least 4GB of memory

Installation steps

# 2. Install backend dependencies
pip install -r requirements.txt
# 3. Configure environment variables
cp .env.example .env
# Edit .env and fill in your LLM API key
# 4. Install frontend dependencies
cd NeurUI
npm install
```
## Starting the services

Frontend (port 8100)

Everything at once

Check service status

Verify

Open the following to confirm the services are up:

  • Backend health check: http://localhost:9527/health
  • Frontend UI: http://localhost:8100

If anything is unclear, see the FAQ.