Install & Run

Prax can be installed and run in three main ways:

1. Locally with Node.js

2. Using Docker

3. Deploying to Cloud (e.g. Railway, Vercel)

Below are instructions for running locally and via Docker.

Prerequisites

• Node.js ≥ v18

• Git

• Docker (for Docker-based setup)

---

Option 1: Run Locally with Node.js

1. Clone the repository

bashCopyEditgit clone https://github.com/prax-ai/prax.git
cd prax

2. Install dependencies

bashCopyEditnpm install

3. Start the app

bashCopyEditnpm run dev

Prax will be available at http://localhost:3000.

---

Option 2: Run with Docker

If you prefer to isolate Prax from your local environment, use Docker:

bashCopyEditdocker compose up --build

This will build and start both the frontend and backend.

By default:

• Frontend: http://localhost:3000

• API: http://localhost:3001

---

Configuration (Environment Variables)

Create a .env file in the root directory to configure API keys, database connections, and other secrets. Example:

envCopyEditOPENAI_API_KEY=sk-...
DATABASE_URL=postgres://...
PORT=3001