Dev Setup

Follow this guide if you want to contribute to the Prax codebase or run the full stack in development mode.

---

1. Clone the Repo

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

---

2. Install Dependencies

Make sure you have Node.js (v18+) and npm installed.

bashCopyEditnpm install

If the project is split into separate frontend/backend folders, repeat npm install in both directories.

---

3. Configure Environment

Copy the sample env file:

bashCopyEditcp .env.example .env

Update the required API keys and environment variables.

---

4. Run Locally

To run with Node.js:

bashCopyEditnpm run dev

Or if using Docker:

bashCopyEditdocker compose up --build

This will launch both the frontend and backend. By default:

• Frontend: http://localhost:3000

• API: http://localhost:3001

---

5. Build for Production

To test a production build:

bashCopyEditnpm run build
npm run start

---

Tools

• Hot reload is enabled in dev mode.

• Logs output to the terminal.

• Flow and node changes persist automatically.