⚠️ These docs are currently under construction and may not be fully accurate.
AIOStreamsAIOStreams
Guides

Development

How to set up AIOStreams locally for development and contribution.

Prerequisites

  • Node.js v22+
  • pnpm v10.15+
  • git

Earlier versions of Node.js or pnpm may work, but are not guaranteed.


Setup

Clone the repository

git clone https://github.com/Viren070/AIOStreams.git
cd AIOStreams

Build the project

pnpm run build

Running in Development Mode

Start the addon in development mode with hot reload for the server package:

pnpm run start:dev

Only changes to the server package benefit from hot reload. Changes to the core package require a rebuild:

pnpm -F core run build

Changes to the frontend package also require a rebuild:

pnpm -F frontend run build

Frontend Hot Reload

For full hot reload including the frontend:

Change the server port

In your root .env, set PORT to something other than 3000 (e.g. 3001). This is the port the backend server listens on.

Configure the frontend's backend URL

Create a .env.development file in packages/frontend/:

NEXT_PUBLIC_BACKEND_BASE_URL=http://localhost:3001

Adjust the port to match the one you set above.

Start all packages with hot reload

pnpm dev

The Next.js dev server will automatically proxy API requests to the backend. The frontend will be available at http://localhost:3000.

If you're only testing backend changes, use pnpm run start:dev instead — it avoids starting the Next.js dev server unnecessarily.


Contributing

Contributions are welcome! Please open an issue or pull request on GitHub. For questions or discussion, join the Discord Server.

On this page