omnichannel-deploy/README.md

90 lines
2.1 KiB
Markdown
Raw Normal View History

# Omnichannel Sothis
Protótipo visual do frontend MVP do sistema Omnichannel da Sothis.
O foco desta versão é apresentação de produto: a aplicação simula fluxos reais de atendimento com dados mockados, UX moderna e navegação entre telas principais.
## O que existe hoje
- Frontend em React + Vite dentro de `frontend/`
- Docker Compose na raiz para subir o frontend desta apresentação
- Telas implementadas:
- Login
- Home / Dashboard
- Chat
- Call / Softphone mock
- Novo Atendimento
## Estrutura esperada do ecossistema
Hoje este repositório cobre o frontend e um `docker-compose.yml` local para desenvolvimento/apresentação.
Para rodar o ambiente completo no futuro, a separação esperada é:
- `frontend`: interface do produto
- `backend`: API e regras de negócio
- `deploy`: repositório raiz de infraestrutura/orquestração, onde ficará o `docker-compose` final com frontend, backend, banco e demais serviços
## Como rodar somente o frontend
### Opção 1: com Docker
Na raiz deste projeto:
```bash
docker compose up -d --build
```
Depois acesse:
```text
http://localhost:3000
```
### Opção 2: com Node local
Entre na pasta do frontend:
```bash
cd frontend
npm install
npm run dev
```
Depois acesse:
```text
http://localhost:3000
```
## Como gerar build do frontend
```bash
cd frontend
npm run build
```
## Para rodar o ambiente completo
Quando a solução estiver separada em múltiplos repositórios, o fluxo esperado será:
1. Fazer `pull` do repositório `frontend`
2. Fazer `pull` do repositório `backend`
3. Fazer `pull` do repositório `deploy`
4. Entrar no repositório `deploy` (raiz de infraestrutura)
5. Subir tudo com:
```bash
docker compose up -d --build
```
Em outras palavras: o `docker compose` definitivo do ambiente completo deve ser executado a partir do repositório `deploy`, que será a raiz de orquestração.
## Documentação
A documentação funcional do frontend está em [`frontend/docs`](./frontend/docs):
- visão geral do projeto
- documentação por módulo/tela
- documentação em formato narrativo/RPG para explicar os casos de uso