w
Documentação Português Get Started

Guia de Instalação

Este guia vai ajudar você a instalar e configurar rapidamente a nossa plataforma.

Requisitos do Sistema

Requisitos Mínimos

  • Node.js: 18.0.0 ou superior
  • npm: 8.0.0 ou superior
  • pnpm: 8.0.0 ou superior (recomendado)
  • Memória: 4GB de RAM
  • Armazenamento: 2GB de espaço disponível

Configuração Recomendada

  • Node.js: 20.0.0 ou superior
  • Memória: 8GB de RAM
  • Armazenamento: 5GB de espaço disponível
  • Sistema Operacional: macOS 12+, Ubuntu 20.04+, Windows 10+

Etapas de Instalação

1. Clonar o Projeto

git clone https://github.com/your-org/wokerjob-tools.git
cd wokerjob-tools

2. Instalar Dependências

Usando pnpm (recomendado):

pnpm install

Ou usando npm:

npm install

3. Configuração do Ambiente

Copie o arquivo de variáveis de ambiente:

cp .env.example .env

Edite o arquivo .env para configurar as variáveis de ambiente necessárias:

# Configuração do banco de dados
DATABASE_URL="postgresql://username:password@localhost:5432/woker_job"

# Segredo JWT
JWT_SECRET="your-jwt-secret-key"

# Configuração do frontend
NUXT_PUBLIC_FRONTEND_BASE_URL="http://localhost:3000"
NUXT_PUBLIC_BACKEND_BASE_URL="http://localhost:3001"

4. Configuração do Banco de Dados

Usando Docker (Recomendado)

# Iniciar o banco de dados PostgreSQL
docker run --name wokerjob-tools-db \
  -e POSTGRES_DB=woker_job \
  -e POSTGRES_USER=postgres \
  -e POSTGRES_PASSWORD=password \
  -p 5432:5432 \
  -d postgres:15

Instalação Manual do PostgreSQL

  1. Baixe e instale o PostgreSQL
  2. Crie o banco de dados:
CREATE DATABASE woker_job;
CREATE USER woker_user WITH PASSWORD 'your_password';
GRANT ALL PRIVILEGES ON DATABASE woker_job TO woker_user;

5. Executar Migrações do Banco de Dados

# Navegar para o diretório do backend
cd apps/back-end

# Executar migrações
pnpm run migration:run

6. Iniciar o Servidor de Desenvolvimento

Iniciar Todos os Serviços (Recomendado)

No diretório raiz do projeto:

pnpm run dev

Iniciar Serviços Separadamente

Serviço de Backend:

cd apps/back-end
pnpm run start:dev

Serviço de Frontend:

cd apps/web
pnpm run dev

7. Verificar a Instalação

  1. Acessar a aplicação do frontend: http://localhost:3000
  2. Acessar a API do backend: http://localhost:3001
  3. Verificar a documentação da API: http://localhost:3001/api

Implantação em Produção

Implantação com Docker

  1. Build da imagem:
docker build -t wokerjob-tools .
  1. Executar o container:
docker run -d \
  --name wokerjob-tools \
  -p 3000:3000 \
  -p 3001:3001 \
  -e DATABASE_URL="your-production-db-url" \
  wokerjob-tools

Implantação Manual

  1. Build da versão de produção:
pnpm run build
  1. Iniciar os serviços em produção:
pnpm run start

Problemas Comuns

Conflitos de Porta

Se as portas 3000 ou 3001 estiverem ocupadas, você pode modificar as variáveis de ambiente:

# Porta do frontend
PORT=3002

# Porta do backend
BACKEND_PORT=3003

Falha na Conexão com o Banco de Dados

  1. Verifique se o serviço do banco de dados está em execução
  2. Verifique o formato da string de conexão
  3. Confirme as configurações de firewall

Falha na Instalação de Dependências

  1. Limpar cache:
pnpm store prune
npm cache clean --force
  1. Excluir node_modules e reinstalar:
rm -rf node_modules
pnpm install

Próximos Passos

Após a instalação, você pode:

Obter Ajuda

Se você encontrar problemas durante a instalação:

  1. Consulte o guia de Solução de Problemas
  2. Consulte as Issues do GitHub
  3. Entre em contato com a equipe de suporte técnico
Esta página foi útil?