Skip to main content

Instalação

Esta página descreve como preparar seu ambiente e colocar o Rouxinol para rodar localmente.

Pré-requisitos​

  • PHP 8.2 ou superior
  • Composer
  • Node.js 20 ou superior
  • Um banco de dados (SQLite para desenvolvimento, MySQL/Postgres em produção)
  • Redis (filas e cache)
  • Janus WebRTC Server — obrigatório, é o servidor responsável por rotear as chamadas de voz

Clonando o projeto​

git clone https://gitlab.com/js-maker/rouxinol.git rouxinol
cd rouxinol

Instalando as dependências​

O projeto expõe um script setup no Composer que executa todo o processo inicial: instala as dependências PHP e JS, cria o .env, gera a chave da aplicação, roda as migrations e builda os assets.

composer run setup

Esse comando executa, em sequência:

composer install
php artisan key:generate
php artisan storage:link
php artisan migrate --force
npm install
npm run build

Subindo o servidor de desenvolvimento​

php artisan serve
php artisan queue:work
php artisan queue:work --queue=realtime-calls
php artisan janus:listen
php artisan janus:whatsapp-listen

Esse comando sobe simultaneamente o servidor HTTP (php artisan serve), o worker de filas (queue:listen), os logs em tempo real (php artisan pail) e o Vite em modo watch (npm run dev).

A aplicação estará disponível em http://localhost:8000.

Próximo passo​

Com o ambiente no ar, siga para Configuração para definir as integrações de voz, WhatsApp e IA.