niivue-nninteractive

An interactive segmentation application that combines nnInteractive with Niivue.

Getting Started

Prerequisites

• Pixi for Python environment management
• Bun for the frontend

Clone the Repository

git clone [email protected]:niivue/niivue-nninteractive.git
cd niivue-nninteractive

Environment Setup

Be sure to set the VITE_API_URL variable in frontend/.env. This defaults to http://localhost:8000, but will need to be modified if you are not running the demo application locally. If the application is running on another machine, use the IP address (or full domain name). This applies to connecting machines over a VPN too.

Backend Setup (API)

1. Install dependencies using pixi:

pixi install

2. Start the development server:

pixi run dev

The API will be available at http://localhost:8000

Frontend Setup (in a separate terminal)

1. Navigate to the frontend directory:

cd frontend

2. Install dependencies:

bun install

3. Start the development server:

bun run dev

The frontend will be available at http://localhost:5173

Development

Backend Commands

• pixi run dev - Start the API development server
• pixi run test - backend test suite

Frontend Commands

• bun run dev - Start the development server
• bun run build - Build for production
• bun run lint - Run linting
• bun run preview - Preview production build