Saltar para o conteúdo principal
PT
Começar
Para programadores

Executar o Volath a partir do código

Para programadores: instale as dependências, compile e execute o Volath a partir do código, em modo de desenvolvimento, e configure a instância.

Transferir antes o instaladorIr para os comandos

Requisitos

O que precisa

  • Node.js e npm

    Node.js 20 ou mais recente e npm. O código dos plugins precisa do Node 22 ou mais recente para correr na sua sandbox.

  • Git

    O Git, disponível no PATH.

  • Um fornecedor de IA e um token do serviço Git

    O mesmo que a aplicação instalada: uma CLI ou uma chave de API e um token do seu serviço Git.

  • Navegadores do Playwright (opcional)

    Apenas para testes reais a partir do código. Instale-os com npx playwright install chromium.

  • MySQL ou MariaDB (opcional)

    Apenas se não quiser o SQLite por omissão. Crie uma base de dados vazia no MySQL 8 ou mais recente, ou no MariaDB. Os dados SQLite existentes não são transferidos.

Comandos

Execute estes comandos na pasta do Volath

Por ordem, uma vez. Cada bloco tem um botão de copiar.

  1. Instale as dependências

    Instale as dependências do frontend e do backend.

    npm install
npm --prefix backend install

  2. Compile e arranque

    Isto compila a aplicação e depois corre o backend em http://localhost:3000 e o frontend em http://localhost:4173.

    npm start

  3. Modo de desenvolvimento (opcional)

    Para trabalhar no código, corra o backend e o frontend em modo de observação. O frontend fica então em http://localhost:5173.

    npm run start:dev

  4. Mude o endereço ou a porta (opcional)

    Copie o ficheiro de ambiente de exemplo e edite o endereço e a porta.

    cp backend/.env.example backend/.env

Configuração

O endereço, os plugins e a base de dados

O nome, o logótipo e o ícone da aplicação são fixos. As definições da instância ficam em backend/.env: o endereço e a porta do backend, o marketplace e a sandbox dos plugins e uma base de dados MySQL ou MariaDB opcional. Tudo o resto edita-se na aplicação.

Variáveis do ficheiro .env da instância
VariávelFinalidade
APP_HOSTEndereço público do backend
PORTPorta do backend (por omissão 3000)
VOLATH_MARKETPLACE_URLOutra pasta de onde ler o marketplace de plugins
VOLATH_PLUGIN_SANDBOXDefina como off para correr o código dos plugins sem a sandbox do Node (não recomendado)
VOLATH_DB_TYPEmysql ou mariadb. Deixe por definir para usar SQLite
VOLATH_DB_HOSTEndereço do servidor da base de dados (por omissão localhost)
VOLATH_DB_PORTPorta do servidor da base de dados (por omissão 3306)
VOLATH_DB_USERUtilizador da base de dados (por omissão root)
VOLATH_DB_PASSWORDPalavra-passe da base de dados
VOLATH_DB_NAMENome da base de dados (por omissão volath)

O frontend encontra o backend em http://localhost:3000. Para usar outro endereço, defina VITE_API_URL ao arrancar o Vite.

A partir do código, os dados ficam em backend/data (database.db, cópias de segurança e capturas de ecrã). Para recomeçar do zero, pare o backend e execute npm run reset e depois acrescente -- --yes para o apagar de facto. Não pode ser desfeito.

Prefere apenas usá-lo?

Corre na sua própria máquina. O seu código, tickets e definições ficam numa base de dados SQLite local, ou no seu próprio MySQL ou MariaDB.

Transferir o VolathLer o guia de configuração