Logo

LIP Documentation System

Atenção: Este é um projeto privado do LIP. Somente desenvolvedores contratados têm permissão para acessar e modificar este código. Se você não foi contratado para trabalhar no projeto, por favor, não continue.

📁 Projetos LIP

O ecossistema LIP é composto por 3 projetos principais:

🎨 LipMKT (Frontend)

  • Tecnologia: Next.js 15 + Redux Toolkit + Firebase
  • Propósito: Dashboard e interface de usuário para gestão de WhatsApp e CRM
  • Porta: http://localhost:3000

⚙️ backendLip (Backend)

  • Tecnologia: Node.js 22 + Express + Prisma + Firebase Admin
  • Propósito: API REST, webhooks WhatsApp, processamento IA
  • Porta: http://localhost:8080

📚 LipDocs (Documentação)

  • Tecnologia: Next.js 15 + MDX + TailwindCSS
  • Propósito: Sistema de documentação técnica
  • Porta: http://localhost:3001

Pré-requisitos

Antes de começar, certifique-se de ter instalado:

  • Git 2.x ou superior
  • Node.js 18.x ou superior
  • npm 9.x ou superior
  • Acesso ao repositório (solicitar ao Tech Lead)

Ferramentas Recomendadas

🚀 Setup Completo dos Projetos

Estratégia de Desenvolvimento

Para desenvolvimento completo, execute os projetos em terminais separados:

Setup Individual - LipDocs

Setup do Projeto

Passo 1: Clonagem do Repositório

Passo 2: Instalação de Dependências

Passo 3: Configuração do Ambiente

Passo 4: Executar em Desenvolvimento

Saída esperada:

▲ Next.js 15.5.5
- Local:        http://localhost:3000
- Environments: .env.local
✓ Ready in 2.3s
✓ Compiled successfully

📁 Estrutura dos Projetos LIP

Após o setup completo, você terá esta estrutura:

C:\pasta-do-projeto\
├── LipMKT\                    # 🎨 Frontend (porta 3000)
│   ├── src/
│   │   ├── app/              # Next.js App Router
│   │   ├── components/       # shadcn/ui + custom
│   │   ├── store/            # Redux Toolkit
│   │   └── contexts/         # Firebase + Realtime
│   ├── package.json
│   └── firebase.json
│
├── backendLip\                # ⚙️ Backend (porta 8080)
│   ├── functions/
│   │   ├── src/              # Express + TypeScript
│   │   │   ├── routes/       # API endpoints
│   │   │   ├── services/     # OpenAI + WhatsApp
│   │   │   └── controllers/  # Request handlers
│   │   └── prisma/           # PostgreSQL schema
│   └── Dockerfile
│
└── LipDocs\                   # 📚 Documentação (porta 3001)
    ├── content/docs/          # Arquivos MDX
    ├── components/            # UI customizada
    ├── lib/                   # Processamento MDX
    └── app/                   # Next.js App Router

Dependências Entre Projetos

  • LipDocs → Independente (documentação)
  • LipMKT → Consome API do backendLip
  • backendLip → Processa webhooks e fornece dados para LipMKT

🔗 Endpoints de Desenvolvimento

Frontend (LipMKT):     http://localhost:3000
Backend (backendLip):  http://localhost:8080
Documentação (LipDocs): http://localhost:3001

📝 Como Fazer Contribuições

1. Identificar o Projeto

Antes de qualquer mudança, identifique em qual projeto trabalhar:

  • Interface/Dashboard → LipMKT
  • API/Backend → backendLip
  • Documentação → LipDocs

2. Cross-Project Changes

Algumas mudanças podem afetar múltiplos projetos:

  • Novos endpoints de API → Atualizar backendLip + documentar em LipDocs
  • Novos componentes UI → Criar em LipMKT + documentar em LipDocs
  • Mudanças no banco → Atualizar schema em backendLip + migrations

3. Criar Branch

4. Commits e Pull Requests

🔄 Desenvolvimento Cross-Project

Cenário: Nova Funcionalidade Completa

  1. Backend First (backendLip):

  2. Frontend Integration (LipMKT):

  3. Documentação (LipDocs):

Debugging Multi-Projeto

Scripts Disponíveis

Adicionar Nova Documentação

1. Criar Arquivo MDX

Conteúdo básico:

2. Adicionar na Navegação

Editar lib/docs-config.ts:

Troubleshooting

Erro: Porta já em uso

Erro: Dependências não encontradas

Erro: TypeScript compilation

Bem-vindo ao LIP! 🚀

Última atualização

26 de novembro de 2025