Skip to content

Development

Jump to bottom
Viren070 edited this page Oct 8, 2025 · 7 revisions

Development

You need Node.js, git, and npm installed. Node v22 and pnpm v10.15 were used in the development of this project. I can not guarantee earlier versions will work.

  1. Clone the project and set it as the current directory 
    git clone https://github.com/Viren070/AIOStreams.git

    cd aiostreams
  2. Install project dependencies 
    pnpm i
  3. Build the project 
    pnpm run build

To start the addon in development mode, run the following command:

pnpm run start:dev

Only changes to the server package have hot reload, meaning no need to rebuild/restart. However, if you make a change in the core package, that needs to be rebuilt.

pnpm -F core run build

Similarly, any changes to frontend also require a rebuild.

pnpm -F frontend run build

It is also possible to develop the frontend package with hot reload, but it requires a bit of extra work.

The frontend requires itself to be connected to the server in order to function correctly, therefore for development purposes, set the NEXT_PUBLIC_BACKEND_BASE_URL environment variable to the currently running backend before running the dev command for the frontend.

Bash:

NEXT_PUBLIC_BACKEND_BASE_URL=http://localhost:3000/api/v1 pnpm run start:frontend:dev -p 3001

PowerShell (Windows):

$Env:NEXT_PUBLIC_BACKEND_BASE_URL="http://localhost:3000/api/v1";pnpm run start:frontend:dev -p 3001

Clone this wiki locally