diff --git a/README.md b/README.md new file mode 100644 index 0000000..42abfff --- /dev/null +++ b/README.md @@ -0,0 +1,89 @@ +# Omnichannel Frontend + +![React](https://img.shields.io/badge/React-18.x-61DAFB) +![Vite](https://img.shields.io/badge/Vite-5.x-646CFF) +![JavaScript](https://img.shields.io/badge/JavaScript-ESM-yellow) +![React Router](https://img.shields.io/badge/Router-React%20Router-red) +![Socket.IO](https://img.shields.io/badge/Realtime-Socket.IO-black) + +Frontend da plataforma Omnichannel da Sothis, responsavel pelas telas de atendimento, chat em tempo real, painel administrativo, painel operacional, gestao de contatos, configuracoes, base de conhecimento e integracoes. + +Este repositorio contem apenas a interface web. Para subir o projeto completo com frontend, backend e configuracao de deploy, utilize o repositorio de orquestracao: + +https://chaleiradev.sothistelecom.com/Sothis/omnichannel-deploy + +## Stack + +- React +- Vite +- JavaScript com ES Modules +- React Router +- Socket.IO Client +- CSS modularizado por contexto de tela + +## Documentacao + +Para documentacao do projeto completo, deploy, ambientes e operacao, acesse: + +https://chaleiradev.sothistelecom.com/Sothis/omnichannel-deploy + +Para documentacao tecnica complementar do frontend, modulos e telas, acesse a wiki: + +https://chaleiradev.sothistelecom.com/Sothis/omnichannel-frontend/wiki + +## Execucao local + +Instale as dependencias: + +```bash +npm install +``` + +Execute em modo desenvolvimento: + +```bash +npm run dev +``` + +O Vite normalmente sobe a aplicacao em: + +```txt +http://localhost:5173 +``` + +## Build e preview + +Gere o build: + +```bash +npm run build +``` + +Execute o preview local do build: + +```bash +npm run preview +``` + +Por padrao, o preview utiliza: + +```txt +http://localhost:3000 +``` + +## Estrutura principal + +- `src/modules/auth`: login e integracoes de autenticacao. +- `src/modules/attendance`: abertura e acompanhamento de atendimentos. +- `src/modules/chat`: chat em tempo real e edicao rapida de contato. +- `src/modules/call`: painel do atendente. +- `src/modules/home`: telas iniciais e direcionamento por perfil. +- `src/modules/management`: painel administrativo, dashboard, contatos, IA, canais, integracoes e configuracoes. +- `src/routes`: rotas principais da aplicacao. +- `src/shared`: componentes, hooks, estilos e servicos compartilhados. + +## Observacoes + +- Este frontend depende da API do `omnichannel-backend`. +- A URL do backend deve ser configurada conforme o ambiente de execucao. +- Para operacao completa, deploy e atualizacao em producao, consulte o repositorio `omnichannel-deploy`.