Run Locally

Prax supports fast local development with minimal setup. You can run both the backend and frontend on your machine using Node.js or Docker.

Prerequisites

  • Node.js v18 or later

  • npm

  • Git

  • Docker (optional, but recommended)

Option 1: Node.js (Without Docker)

To run Prax without containers:

  1. Clone the repository

  2. Install dependencies

  3. Run the app with the provided script

This will start both the backend and frontend locally.

Prax will be available at:

  • Frontend: http://localhost:3000

  • Backend API: http://localhost:3001

Environment variables should be configured in a .env file. See .env.example in the repo for defaults.

Option 2: Docker Compose

Prax includes a working docker-compose.yml file in the root directory.

To start everything with Docker:

bashCopyEditdocker compose up --build

This launches all services, including backend and frontend, in isolated containers. This is the preferred method for local testing if you want to mirror production environments.

PreviousConfig & Env VarsNextProduction Setup

Last updated