Bem-vindo ao BITIO Engineering Docs

Documentação técnica completa da plataforma BITIO - sistema de cardápio digital com geração de leads e automação de marketing.

O que é o BITIO?

BITIO é uma plataforma multi-tenant completa que transforma cardápios físicos em experiências digitais inteligentes:

• Cardápio Digital: Interface responsiva e otimizada para QR Code
• Geração de Leads: Captura automática via cupons de desconto
• Automação de Marketing: Integração WhatsApp + CRM
• Analytics: Dashboard com métricas de negócio
• Multi-tenant: Isolamento completo por restaurante

Arquitetura Técnica

Stack Principal

Camada	Tecnologia	Justificativa
Frontend	Next.js 14 + React Query	SSG para performance, dashboard admin
API	Lambda + API Gateway	Serverless, escala automaticamente
Database	PostgreSQL + Prisma	ACID, relacional, multi-tenant
Storage	S3 + CloudFront	Static hosting, CDN global
Queue	SQS + Lambda	Background jobs, reliable messaging

Estrutura do Monorepo

BITIO/
├── apps/
│   ├── frontend/           # Next.js Dashboard + Public Routes
│   ├── backend/            # Lambda API Handlers  
│   ├── docs/              # Esta documentação (Docusaurus)
│   ├── infrastructure/    # Terraform IaC
│   └── public-modules/    # Módulos públicos por tenant
├── packages/
│   ├── design-system/     # UI Components + Design Tokens
│   └── shared/           # Utilitários compartilhados
└── tools/                # Scripts de automação

Quick Start

1. Setup do Ambiente

# Clone do repositório
git clone https://gitlab.com/2biz-group/BITIO.git
cd BITIO

# Instalar dependências (workspace)
npm install

# Setup das variáveis de ambiente
cp apps/frontend/.env.example apps/frontend/.env.local
cp apps/backend/.env.example apps/backend/.env.local

2. Desenvolvimento Local

# Executar todos os serviços
npm run dev

# Ou individualmente:
npm run dev:frontend    # Port 3000
npm run dev:backend     # Serverless offline
npm run dev:docs        # Esta documentação (port 3001)

3. Primeira Contribuição

# Criar feature branch
git checkout -b feature/minha-feature

# Fazer alterações...
# Commit seguindo Conventional Commits
git commit -m "feat: adicionar nova funcionalidade"

# Push e PR
git push origin feature/minha-feature

Navegação da Documentação

Para Desenvolvedores Novos

1. Getting Started - Setup completo do ambiente
2. Arquitetura - Visão geral dos componentes
3. Guidelines - Padrões de código e Git workflow

Para Frontend Developers

1. Frontend Architecture - Arquitetura em camadas
2. Integration Guides - Integração com APIs externas

Para Backend Developers

1. Backend Architecture - Clean Architecture patterns
2. Data Modeling - Prisma ORM + PostgreSQL
3. Lambda API - Serverless API patterns

Para Entender o Projeto

1. Project Scope - Módulos e features
2. Development Phases - Fases do MVP
3. Security - Práticas de segurança

Épicos de Desenvolvimento

Épico	Status	Descrição	Custo AWS
E0-E2	MVP	Cardápio + Lead capture básico	~$50/mês
E3-E4	Planning	Pesquisa NPS + Analytics	~$100/mês
E5	Roadmap	Reservas + Clean Architecture	~$200/mês
E6+	Future	CRM completo + WhatsApp	~$400/mês

MVP Atual (E0-E2)

O sistema atual implementa fat lambdas para simplicidade. A partir do E5, migraremos para Clean Architecture completa com Domain-Driven Design.

Como Contribuir

Fluxo de Contribuição

1. Ler documentação relevante à sua área
2. Criar feature branch seguindo padrões Git
3. Executar testes localmente antes do commit
4. Escrever/atualizar documentação se necessário
5. Abrir Pull Request com descrição detalhada

Padrões Obrigatórios

• Conventional Commits: feat:, fix:, docs:, etc.
• TypeScript strict: Zero any, tipos completos
• Testes: Unit para lógica, E2E para fluxos críticos
• ESLint + Prettier: Formatação automática via pre-commit

Canais de Comunicação

• GitLab Issues: Bugs e feature requests
• Slack #engenharia-bitio: Discussões técnicas rápidas
• Weekly Sync: Alinhamento de arquitetura

---

Ready to build something amazing? Começar o Setup →