Guia de Início Rápido

Este guia irá ajudá-lo a configurar e executar o APAH Assistant em poucos minutos.

Pré-requisitos

Antes de começar, certifique-se de que tem instalado:

• Node.js versão 20.0 ou superior
• pnpm (gestor de pacotes recomendado)
• Docker e Docker Compose (para a base de dados)
• Git

Verificar instalações

node --version    # v20.0.0 ou superior
pnpm --version    # 8.0.0 ou superior
docker --version  # 20.0.0 ou superior

Passos Rápidos

1. Clonar o repositório

git clone https://github.com/Visual-Thinking/apah-assistant.git
cd apah-assistant

2. Instalar dependências

pnpm install

3. Configurar variáveis de ambiente

Copie o ficheiro de exemplo e configure as variáveis necessárias:

cp .env.example .env

Edite o ficheiro .env com as suas configurações. Consulte o guia de configuração para mais detalhes.

4. Iniciar a base de dados

# Usando Docker Compose
docker-compose up -d

# Ou usando o script incluído
./start-database.sh

5. Executar migrações

pnpm db:migrate

6. Iniciar o servidor de desenvolvimento

pnpm dev

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

Comandos Úteis

Comando	Descrição
pnpm dev	Inicia o servidor de desenvolvimento
pnpm build	Cria a build de produção
pnpm start	Inicia o servidor de produção
pnpm typecheck	Verifica tipos TypeScript
pnpm check	Executa verificações com Biome
pnpm db:studio	Abre o Drizzle Studio
pnpm db:push	Aplica alterações ao schema
pnpm db:generate	Gera migrações

Estrutura Básica do Projeto

apah-assistant/
├── src/
│   ├── app/          # App Router (Next.js)
│   ├── components/   # Componentes React
│   ├── server/       # Lógica do servidor
│   └── lib/          # Utilitários
├── drizzle/          # Migrações da BD
├── public/           # Ficheiros estáticos
└── documentation/    # Esta documentação

Próximos Passos

• Instalação detalhada - Instruções completas
• Configuração - Todas as variáveis de ambiente
• Arquitetura - Entenda a estrutura do projeto