diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..ad58fc0 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,13 @@ +node_modules +.next +.git +.gitignore +README.md +*.md +.env* +!.env.production +Dockerfile +.dockerignore +docs/ +helm/ +skaffold.yaml diff --git a/Dockerfile b/Dockerfile index 493342f..e6fa649 100644 --- a/Dockerfile +++ b/Dockerfile @@ -2,7 +2,6 @@ FROM node:20-alpine AS base -# Install dependencies only when needed FROM base AS deps # Check https://github.com/nodejs/docker-node/tree/b4117f9333da4138b03a546ec926ef50a31506c3#nodealpine to understand why libc6-compat might be needed. RUN apk add --no-cache libc6-compat @@ -24,6 +23,9 @@ WORKDIR /app COPY --from=deps /app/node_modules ./node_modules COPY . . +# Limit Node.js memory to avoid OOM in constrained build environments +ENV NODE_OPTIONS="--max-old-space-size=2048" + # Execute fumadocs-mdx after copying all files RUN npx fumadocs-mdx diff --git a/app/(home)/layout.tsx b/app/(home)/layout.tsx index eae5d32..63aeaa4 100644 --- a/app/(home)/layout.tsx +++ b/app/(home)/layout.tsx @@ -1,25 +1,6 @@ -"use client"; -import { useEffect } from 'react'; import { HomeLayout } from 'fumadocs-ui/layouts/home'; import { baseOptions } from '@/app/layout.config'; export default function Layout({ children }: { children: React.ReactNode }) { - useEffect(() => { - const interval = setInterval(() => { - const searchButton = document.querySelector('[data-search-full]'); - - if (searchButton && searchButton.textContent?.includes('Search')) { - searchButton.childNodes.forEach((node) => { - if (node.nodeType === Node.TEXT_NODE && node.textContent?.trim() === 'Search') { - node.textContent = 'Buscar'; - } - }); - - clearInterval(interval); - } - }, 100); - return () => clearInterval(interval); - }, []); - return {children}; } diff --git a/app/docs/[[...slug]]/page.tsx b/app/docs/[[...slug]]/page.tsx index 7c622eb..174369b 100644 --- a/app/docs/[[...slug]]/page.tsx +++ b/app/docs/[[...slug]]/page.tsx @@ -24,13 +24,7 @@ export default async function Page(props: { }; return ( - + {page.data.title} {page.data.description} diff --git a/app/layout.config.tsx b/app/layout.config.tsx index a7a636a..bc72e00 100644 --- a/app/layout.config.tsx +++ b/app/layout.config.tsx @@ -9,26 +9,17 @@ import type { BaseLayoutProps } from 'fumadocs-ui/layouts/shared'; */ import Image from 'next/image'; -import LogoRedeMapas from '../public/svg/dark-logo-rede-das-artes.svg'; -import LogoRedeMapasDark from '../public/svg/light-logo-rede-das-artes.svg'; +import LogoCultBR from '../public/img/cultbr-fundo-claro.png'; +import LogoCultBRDark from '../public/img/cultbr-fundo-escuro.png'; export const baseOptions: BaseLayoutProps = { - githubUrl: 'https://github.com/redemapas/manual', nav: { title: ( <> - {/* - - */} - M - M + Cult Editais + Cult Editais -

Manual Rede das Artes

+

Manual Cult Editais

), }, diff --git a/app/layout.tsx b/app/layout.tsx index 4c9063f..23967c8 100644 --- a/app/layout.tsx +++ b/app/layout.tsx @@ -7,11 +7,24 @@ const inter = Inter({ subsets: ['latin'], }); +const ptBR = { + search: 'Buscar', + searchNoResult: 'Nenhum resultado encontrado.', + toc: 'Nesta página', + tocNoHeadings: 'Sem títulos', + lastUpdate: 'Última atualização', + chooseLanguage: 'Selecionar idioma', + nextPage: 'Próxima página', + previousPage: 'Página anterior', + chooseTheme: 'Selecionar tema', + editOnGithub: 'Editar no GitHub', +}; + export default function Layout({ children }: { children: ReactNode }) { return ( - - - {children} + + + {children} ); diff --git a/components/FeaturedHome.tsx b/components/FeaturedHome.tsx index bf17803..e117117 100644 --- a/components/FeaturedHome.tsx +++ b/components/FeaturedHome.tsx @@ -1,41 +1,28 @@ import Image from 'next/image'; -import imgAgents from './img/home/agents.svg'; -import imgManagers from './img/home/managers.svg'; -import imgDevelopers from './img/home/developers.svg'; +import iconProponente from './img/home/icon-proponente.svg'; +import iconGestor from './img/home/icon-gestor.svg'; const roles = [ { - title: 'Agentes Artísticos', - image: imgAgents, - alt: 'Pessoa dançando com o sol ao fundo', + title: 'Proponentes', + image: iconProponente, + alt: 'Ícone de agente cultural proponente', description: - 'Pessoas que desejam divulgar a agenda de seus circuitos artísticos, eventos e outras oportunidades.', - link: '/docs/usuarios/intro', + 'Agentes culturais, artistas e produtores que desejam se inscrever em editais da Política Nacional Aldir Blanc e gerenciar suas propostas.', + link: '/docs/proponente/intro', linkText: 'Saiba mais', bgColor: 'bg-blue-900', textColor: 'text-white', roundedClass: 'lg:rounded-l-[2rem]', }, { - title: 'Gestores', - image: imgManagers, - alt: 'Pintora criando em tela com pincéis', + title: 'Gestores do Ente Federativo', + image: iconGestor, + alt: 'Ícone de gestor do ente federativo', description: - 'Coordenação do processo de editais e iniciativas, publicação dos resultados e monitoramento da execução de editais.', - link: '/docs/gestores/intro', - linkText: 'Saiba mais', - bgColor: 'bg-blue-900', - textColor: 'text-white', - roundedClass: 'lg:rounded-l-[2rem]', - }, - { - title: 'Desenvolvedores', - image: imgDevelopers, - alt: 'Equipe trabalhando com tecnologia e engrenagens', - description: - 'Pessoa responsável por manter a infraestrutura e dar manutenção nas tecnologias digitais utilizadas pela Rede das Artes.', - link: '/docs/devs', + 'Servidores de secretarias de cultura estaduais e municipais que publicam editais, avaliam inscrições e acompanham a execução dos projetos selecionados.', + link: '/docs/gestor/intro', linkText: 'Saiba mais', bgColor: 'bg-blue-900', textColor: 'text-white', diff --git a/components/Footer.tsx b/components/Footer.tsx index 189127b..a206a69 100644 --- a/components/Footer.tsx +++ b/components/Footer.tsx @@ -1,63 +1,17 @@ import React from 'react'; import Image from 'next/image'; -// Import light and dark images -import FelicilabLight from './img/light-felicilab.png'; -import FelicilabDark from './img/dark-felicilab.png'; -import MutiraoLight from './img/light-mutirao.png'; -import MutiraoDark from './img/dark-mutirao.png'; -import LabDoFuturoLight from './img/light-lab-do-futuro-ufc.png'; -import LabDoFuturoDark from './img/dark-lab-do-futuro-ufc.png'; -import UFCLight from './img/light-ufc.png'; -import UFCDark from './img/dark-ufc.png'; -import RedeDasArtesLight from './img/light-rede-das-artes-funarte.png'; -import RedeDasArtesDark from './img/dark-rede-das-artes-funarte.png'; -import FunarteLight from './img/light-funarte.png'; -import FunarteDark from './img/dark-funarte.png'; -import MincGovernoFederalLight from './img/light-minc-governo-federal.png'; -import MincGovernoFederalDark from './img/dark-minc-governo-federal.png'; +import LogoInstitucional from './img/SNC+PNAB+MinC+Gov.png'; const Footer = () => { return (

- Esse material é fruto do Programa de Difusão Nacional - Funarte Redes das Artes, realizado pelo Laboratório do Futuro (entidade vinculada à Universidade Federal do Ceará) no ano de 2025. + Manual de usuário do Cult Editais — plataforma do Ministério da Cultura (MinC) para publicação e gestão de editais da Política Nacional Aldir Blanc por estados e municípios brasileiros.

-
-
-
- Felicilab - Felicilab -
-
- Mutirão - Mutirão -
-
- Lab do Futuro UFC - Lab do Futuro UFC -
-
- UFC - UFC -
-
- -
-
- Rede das Artes Funarte - Rede das Artes Funarte -
-
- Funarte - Funarte -
-
- MinC Governo Federal - MinC Governo Federal -
-
+
+ SNC + PNAB + MinC + Governo Federal
); diff --git a/components/HeroHome.tsx b/components/HeroHome.tsx index bffbd2a..9dc422c 100644 --- a/components/HeroHome.tsx +++ b/components/HeroHome.tsx @@ -4,16 +4,16 @@ export default function Example() {
-

- Rede das Artes +

+ Cult Editais

-

- Plataforma colaborativa criada para mapear, conectar e fortalecer iniciativas artísticas em todo o Brasil. +

+ Plataforma do Ministério da Cultura para publicação e gestão de editais da Política Nacional Aldir Blanc em estados e municípios de todo o Brasil.

Introdução diff --git a/components/img/SNC+PNAB+MinC+Gov.png b/components/img/SNC+PNAB+MinC+Gov.png new file mode 100644 index 0000000..6591ca5 Binary files /dev/null and b/components/img/SNC+PNAB+MinC+Gov.png differ diff --git a/components/img/dark-felicilab.png b/components/img/dark-felicilab.png deleted file mode 100644 index f60045d..0000000 Binary files a/components/img/dark-felicilab.png and /dev/null differ diff --git a/components/img/dark-funarte.png b/components/img/dark-funarte.png deleted file mode 100644 index 12e2d60..0000000 Binary files a/components/img/dark-funarte.png and /dev/null differ diff --git a/components/img/dark-lab-do-futuro-ufc.png b/components/img/dark-lab-do-futuro-ufc.png deleted file mode 100644 index 5b72dd1..0000000 Binary files a/components/img/dark-lab-do-futuro-ufc.png and /dev/null differ diff --git a/components/img/dark-minc-governo-federal.png b/components/img/dark-minc-governo-federal.png deleted file mode 100644 index 0cf19d5..0000000 Binary files a/components/img/dark-minc-governo-federal.png and /dev/null differ diff --git a/components/img/dark-mutirao.png b/components/img/dark-mutirao.png deleted file mode 100644 index 7df1f37..0000000 Binary files a/components/img/dark-mutirao.png and /dev/null differ diff --git a/components/img/dark-rede-das-artes-funarte.png b/components/img/dark-rede-das-artes-funarte.png deleted file mode 100644 index f908a60..0000000 Binary files a/components/img/dark-rede-das-artes-funarte.png and /dev/null differ diff --git a/components/img/dark-ufc.png b/components/img/dark-ufc.png deleted file mode 100644 index aac5360..0000000 Binary files a/components/img/dark-ufc.png and /dev/null differ diff --git a/components/img/home/icon-gestor.svg b/components/img/home/icon-gestor.svg new file mode 100644 index 0000000..9321512 --- /dev/null +++ b/components/img/home/icon-gestor.svg @@ -0,0 +1,57 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/components/img/home/icon-proponente.svg b/components/img/home/icon-proponente.svg new file mode 100644 index 0000000..f3447db --- /dev/null +++ b/components/img/home/icon-proponente.svg @@ -0,0 +1,40 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/components/img/light-felicilab.png b/components/img/light-felicilab.png deleted file mode 100644 index ac617f0..0000000 Binary files a/components/img/light-felicilab.png and /dev/null differ diff --git a/components/img/light-funarte.png b/components/img/light-funarte.png deleted file mode 100644 index e6c1347..0000000 Binary files a/components/img/light-funarte.png and /dev/null differ diff --git a/components/img/light-lab-do-futuro-ufc.png b/components/img/light-lab-do-futuro-ufc.png deleted file mode 100644 index 977aedc..0000000 Binary files a/components/img/light-lab-do-futuro-ufc.png and /dev/null differ diff --git a/components/img/light-minc-governo-federal.png b/components/img/light-minc-governo-federal.png deleted file mode 100644 index ab540d0..0000000 Binary files a/components/img/light-minc-governo-federal.png and /dev/null differ diff --git a/components/img/light-mutirao.png b/components/img/light-mutirao.png deleted file mode 100644 index a8d2c3f..0000000 Binary files a/components/img/light-mutirao.png and /dev/null differ diff --git a/components/img/light-rede-das-artes-funarte.png b/components/img/light-rede-das-artes-funarte.png deleted file mode 100644 index 3228e9f..0000000 Binary files a/components/img/light-rede-das-artes-funarte.png and /dev/null differ diff --git a/components/img/light-ufc.png b/components/img/light-ufc.png deleted file mode 100644 index 8829d44..0000000 Binary files a/components/img/light-ufc.png and /dev/null differ diff --git a/components/mdx/mermaid.tsx b/components/mdx/mermaid.tsx index 342820d..a565e9f 100644 --- a/components/mdx/mermaid.tsx +++ b/components/mdx/mermaid.tsx @@ -16,7 +16,7 @@ export function Mermaid({ chart }: { chart: string }) { async function renderChart() { const mermaidConfig: MermaidConfig = { startOnLoad: false, - securityLevel: 'loose', + securityLevel: 'strict', fontFamily: 'inherit', themeCSS: 'margin: 1.5rem auto 0;', theme: resolvedTheme === 'dark' ? 'dark' : 'default', diff --git a/content/docs/devs/00_visao_geral_plataforma/01_funcoes_tecnologias.mdx b/content/docs/devs/00_visao_geral_plataforma/01_funcoes_tecnologias.mdx deleted file mode 100644 index 6e04446..0000000 --- a/content/docs/devs/00_visao_geral_plataforma/01_funcoes_tecnologias.mdx +++ /dev/null @@ -1,138 +0,0 @@ ---- -title: Funções Essenciais e Tecnologias Chave -description: Detalhamento das tecnologias e dependências principais da plataforma ---- - -# Funções Essenciais e Tecnologias Chave - -Esta seção detalha as tecnologias fundamentais que compõem a plataforma Mapas Culturais, suas funções específicas e como elas se integram para formar um sistema robusto e escalável. - -## Stack Tecnológico - -### Backend (PHP) - -O backend é construído em **PHP** utilizando um conjunto de bibliotecas modernas e bem estabelecidas: - -#### Framework e API -- **`slim/slim`** - Micro-framework PHP para construção de APIs RESTful -- **`doctrine/orm`** - ORM (Object-Relational Mapper) para abstração de banco de dados -- **`respect/validation`** - Motor de validação para garantir integridade dos dados - -#### Autenticação e Segurança -- **`firebase/php-jwt`** - Implementação JWT para autenticação segura -- **`opauth/openid`** - Suporte para autenticação OpenID -- **`opauth/logincidadao`** - Integração com Login Cidadão (gov.br) -- **`opauth/authentik`** - Suporte para Authentik SSO - -#### Comunicação e Processamento -- **`symfony/mailer`** - Sistema de envio de e-mails para notificações -- **`phpoffice/phpspreadsheet`** - Processamento de planilhas (import/export) -- **`monolog/monolog`** - Sistema de logging robusto -- **`michelf/php-markdown`** - Parser Markdown para conteúdo dinâmico - -#### Templating -- **`mustache/mustache`** - Sistema de templates sem lógica para renderização - -### Frontend (JavaScript) - -O frontend utiliza tecnologias modernas para uma experiência de usuário rica: - -#### Build e Empacotamento -- **`laravel-mix`** - API fluente para configuração do Webpack -- **`webpack`** - Empacotador de módulos JavaScript -- **`fast-glob`** - Biblioteca de globbing para correspondência de arquivos - -#### Estilização -- **`sass`** / **`sass-loader`** - Pré-processador CSS -- **`postcss`** - Pós-processamento CSS com plugins -- **`resolve-url-loader`** - Resolução de URLs em arquivos CSS/Sass - -## Funções Essenciais da Plataforma - -### 1. Gestão de Usuários e Autenticação -- **Registro e login** de usuários -- **Múltiplos provedores** de autenticação (OpenID, Login Cidadão, Authentik) -- **Autorização baseada em papéis** e permissões -- **Gestão de sessões** segura com JWT - -### 2. Gestão de Conteúdo Cultural -- **CRUD completo** para entidades culturais (agentes, espaços, eventos, projetos) -- **Upload e processamento** de arquivos e imagens -- **Validação robusta** de dados de entrada -- **Versionamento** de informações - -### 3. Sistema de Busca e Descoberta -- **Busca textual** com indexação eficiente -- **Filtros geográficos** baseados em localização -- **Busca facetada** por categorias e tags -- **API de busca** para integrações externas - -### 4. Gestão de Oportunidades -- **Criação e gestão** de editais e chamadas públicas -- **Processo de inscrição** online com formulários dinâmicos -- **Sistema de avaliação** configurável -- **Acompanhamento** de projetos aprovados - -### 5. Comunicação e Notificações -- **Sistema de e-mail** para notificações automáticas -- **Alertas** personalizados por usuário -- **Comunicação** entre agentes culturais -- **Relatórios** e estatísticas - -### 6. Importação e Exportação de Dados -- **Import/export** via planilhas Excel/CSV -- **APIs** para integração com sistemas externos -- **Backup** e migração de dados -- **Sincronização** entre instâncias - -## Inovações e Diferenciais - -### Arquitetura Modular -- **Plugins** para extensão de funcionalidades -- **Módulos** independentes e reutilizáveis -- **Temas** personalizáveis por instituição -- **APIs** padronizadas para integrações - -### Foco no Setor Cultural -- **Modelos de dados** específicos para cultura -- **Fluxos de trabalho** adaptados ao setor -- **Terminologia** e conceitos culturais -- **Integração** com políticas públicas - -### Código Aberto e Colaborativo -- **Transparência** total do código -- **Comunidade ativa** de desenvolvedores -- **Contribuições** da comunidade -- **Documentação** aberta e colaborativa - -### Suporte a Múltiplas Instâncias -- **Personalização** por instituição -- **Configuração** flexível -- **Branding** customizável -- **Integração** com sistemas locais - -## Requisitos de Sistema - -### Servidor -- **PHP 8.0+** com extensões necessárias -- **PostgreSQL 12+** com extensões geoespaciais -- **Redis** para cache e sessões -- **Nginx/Apache** como servidor web - -### Desenvolvimento -- **Node.js 16+** para build do frontend -- **Composer** para dependências PHP -- **Git** para controle de versão -- **Docker** (opcional) para containerização - -## Próximos Passos - -Para entender como essas tecnologias se integram na arquitetura geral: - -1. **[Arquitetura do Sistema](02_arquitetura_sistema)** - Diagramas e fluxos de dados -2. **[Entidades](../02_guia_avancado_plataforma/01_entidades__entities__)** - Modelos de dados implementados -3. **[Componentes Vue](../02_guia_avancado_plataforma/02_componentes_vue__vue_components__)** - Interface de usuário - ---- - -*Esta seção fornece a base técnica para entender as escolhas arquiteturais da plataforma.* diff --git a/content/docs/devs/00_visao_geral_plataforma/02_arquitetura_sistema.mdx b/content/docs/devs/00_visao_geral_plataforma/02_arquitetura_sistema.mdx deleted file mode 100644 index ead7966..0000000 --- a/content/docs/devs/00_visao_geral_plataforma/02_arquitetura_sistema.mdx +++ /dev/null @@ -1,307 +0,0 @@ ---- -title: Arquitetura do Sistema -description: Diagramas, componentes e fluxos de dados da plataforma Mapas Culturais ---- - -# Arquitetura do Sistema - -A arquitetura do Mapas Culturais segue os princípios de **separação de responsabilidades**, **modularidade** e **escalabilidade**, permitindo um desenvolvimento sustentável e manutenção eficiente da plataforma. - -## Visão Geral da Arquitetura - - - -### Explicação do Diagrama - -**Interface do Usuário (Frontend):** Esta camada representa a aplicação do lado do cliente com a qual os usuários interagem através de navegadores web. Ela é construída usando tecnologias web padrão (HTML, CSS, JavaScript) e seu fluxo de trabalho de desenvolvimento é gerenciado por ferramentas como Webpack e Laravel Mix para compilação e empacotamento eficiente de ativos. - -**Backend (PHP - Slim Framework):** Este é o núcleo da aplicação, construído usando o PHP Slim Framework. Ele abriga a camada de API e serviços web, que lida com toda a lógica de negócios, processamento de dados e interações com outros serviços. Os componentes chave incluem: -- **Lógica de Aplicação Central:** As principais funcionalidades e regras de negócio da plataforma -- **Módulos e Plugins:** Fornecem extensibilidade, permitindo que novas funcionalidades sejam adicionadas -- **Autenticação:** Gerencia autenticação e autorização de usuários com múltiplos provedores -- **Serviços de E-mail:** Lida com envio de e-mails para notificações e comunicações -- **Processamento de Planilhas:** Permite importação e exportação de dados -- **Renderização de Markdown:** Processa conteúdo Markdown para exibição -- **Templating:** Usa motor de template (Mustache) para gerar conteúdo HTML dinâmico - -**Camada de Dados:** Responsável pela persistência dos dados. O backend interage com o banco de dados principalmente através do Doctrine ORM, que abstrai as operações do banco de dados e permite que os desenvolvedores trabalhem com objetos em vez de SQL bruto. - -**Serviços/Integrações Externas:** Sistemas externos com os quais o Mapas Culturais interage, incluindo provedores de autenticação, serviços de e-mail, processamento de documentos e renderização de conteúdo. - -## Camadas da Arquitetura - -### 1. Camada de Apresentação (Frontend) - -**Tecnologias**: Vue.js, Webpack, Sass, JavaScript ES6+ - -#### Componentes Principais: -- **Interface do Usuário**: Templates HTML com componentes Vue reativos -- **Gerenciamento de Estado**: Estado local dos componentes e comunicação via props/events -- **Roteamento**: Navegação SPA (Single Page Application) -- **Build System**: Webpack com Laravel Mix para otimização de assets - -#### Responsabilidades: -- Renderização da interface de usuário -- Validação de formulários no cliente -- Comunicação com a API backend -- Gerenciamento de sessão do usuário - -### 2. Camada de API (Backend) - -**Tecnologias**: PHP, Slim Framework, JWT - -#### Componentes Principais: -- **Controladores REST**: Endpoints para operações CRUD -- **Middleware**: Autenticação, autorização, logging, CORS -- **Roteamento**: Definição de rotas da API -- **Serialização**: Transformação de dados para JSON - -#### Responsabilidades: -- Exposição de APIs RESTful -- Autenticação e autorização -- Validação de dados de entrada -- Orquestração da lógica de negócio - -### 3. Camada de Negócio - -**Tecnologias**: PHP, Doctrine ORM - -#### Componentes Principais: -- **Entidades**: Modelos de domínio (Agent, Space, Event, Project, Opportunity) -- **Serviços**: Lógica de negócio complexa -- **Repositórios**: Acesso a dados abstraído -- **Eventos**: Sistema de eventos para desacoplamento - -#### Responsabilidades: -- Implementação das regras de negócio -- Validação de dados de domínio -- Coordenação entre diferentes módulos -- Processamento de workflows complexos - -### 4. Camada de Dados - -**Tecnologias**: PostgreSQL, Redis, Doctrine ORM - -#### Componentes Principais: -- **ORM**: Mapeamento objeto-relacional com Doctrine -- **Banco Principal**: PostgreSQL com extensões geoespaciais -- **Cache**: Redis para sessões e cache de dados -- **Migrações**: Versionamento do schema do banco - -#### Responsabilidades: -- Persistência de dados -- Consultas otimizadas -- Cache de dados frequentemente acessados -- Backup e recuperação - -## Fluxos de Dados Principais - -### 1. Fluxo de Autenticação - - - -### 2. Fluxo de Criação de Entidade - - - -### 3. Fluxo de Busca - - - -## Módulos e Plugins - -### Arquitetura Modular - -A plataforma utiliza uma arquitetura modular que permite: - -- **Extensibilidade**: Novos módulos podem ser adicionados sem modificar o core -- **Reutilização**: Módulos podem ser reutilizados em diferentes contextos -- **Manutenibilidade**: Cada módulo tem responsabilidades bem definidas -- **Testabilidade**: Módulos podem ser testados independentemente - -### Principais Módulos - -#### Core Modules -- **Entities**: Gerenciamento das entidades principais -- **Authentication**: Sistema de autenticação múltipla -- **Search**: Motor de busca e indexação -- **Notifications**: Sistema de notificações - -#### Feature Modules -- **Opportunities**: Gestão de editais e oportunidades -- **Evaluations**: Métodos de avaliação -- **Reports**: Geração de relatórios -- **Themes**: Personalização visual - -#### Integration Modules -- **LGPD**: Conformidade com proteção de dados -- **Spreadsheets**: Import/export de dados -- **Geolocation**: Funcionalidades geoespaciais - -## Padrões Arquiteturais - -### 1. Repository Pattern -- Abstração do acesso a dados -- Facilita testes unitários -- Permite troca de implementação de persistência - -### 2. Service Layer -- Encapsula lógica de negócio complexa -- Promove reutilização de código -- Facilita manutenção e evolução - -### 3. Event-Driven Architecture -- Desacoplamento entre módulos -- Extensibilidade via listeners -- Auditoria e logging automáticos - -### 4. API-First Design -- Frontend e backend independentes -- Facilita integrações externas -- Permite múltiplos clientes - -## Considerações de Performance - -### Otimizações Implementadas - -#### Backend -- **Query Optimization**: Consultas otimizadas com índices apropriados -- **Lazy Loading**: Carregamento sob demanda de relacionamentos -- **Connection Pooling**: Pool de conexões com banco de dados -- **Response Caching**: Cache de respostas da API - -#### Frontend -- **Code Splitting**: Divisão do código em chunks menores -- **Asset Optimization**: Minificação e compressão de assets -- **Lazy Loading**: Carregamento sob demanda de componentes -- **Service Workers**: Cache offline de recursos - -#### Infraestrutura -- **Database Indexing**: Índices otimizados para consultas frequentes -- **Redis Caching**: Cache distribuído para dados frequentes -- **CDN**: Distribuição de assets estáticos -- **Load Balancing**: Distribuição de carga entre servidores - -## Segurança - -### Medidas de Segurança Implementadas - -- **JWT Authentication**: Tokens seguros para autenticação -- **HTTPS Enforcement**: Comunicação criptografada -- **Input Validation**: Validação rigorosa de entrada -- **SQL Injection Prevention**: Uso de prepared statements -- **XSS Protection**: Sanitização de dados de saída -- **CSRF Protection**: Tokens CSRF para formulários -- **Rate Limiting**: Limitação de requisições por IP - -## Próximos Passos - -Para aprofundar o conhecimento sobre a implementação: - -1. **[Entidades](../02_guia_avancado_plataforma/01_entidades__entities__)** - Modelos de dados detalhados -2. **[Componentes Vue](../02_guia_avancado_plataforma/02_componentes_vue__vue_components__)** - Implementação do frontend -3. **[Classe API](../02_guia_avancado_plataforma/03_classe_api_)** - Comunicação entre camadas - ---- - -*Esta arquitetura foi projetada para suportar o crescimento da plataforma mantendo qualidade e performance.* diff --git a/content/docs/devs/00_visao_geral_plataforma/03_casos_uso_implementacoes.mdx b/content/docs/devs/00_visao_geral_plataforma/03_casos_uso_implementacoes.mdx deleted file mode 100644 index aea63ca..0000000 --- a/content/docs/devs/00_visao_geral_plataforma/03_casos_uso_implementacoes.mdx +++ /dev/null @@ -1,228 +0,0 @@ ---- -title: Casos de Uso e Implementações -description: Usos no mundo real, exemplos de implementações e comparações com outras ferramentas ---- - -# Casos de Uso e Implementações - -O Mapas Culturais é uma plataforma amplamente adotada, principalmente no Brasil e em outros países da América Latina, para mapeamento e gestão cultural. Sua natureza de código aberto e recursos colaborativos levaram a inúmeras implementações no mundo real por várias instituições governamentais e culturais. - -## Principais Casos de Uso - -### Política e Planejamento Cultural -As autoridades públicas utilizam o Mapas Culturais para obter uma visão abrangente das atividades culturais, agentes, espaços e projetos dentro de suas jurisdições. Essa abordagem baseada em dados auxilia na: - -- **Formulação de políticas culturais** baseada em evidências -- **Implementação de programas** culturais direcionados -- **Alocação de recursos** de forma estratégica -- **Planejamento territorial** da cultura - -### Engajamento Cidadão e Acesso à Cultura -A plataforma serve como um portal público onde os cidadãos podem: - -- **Descobrir eventos culturais** em sua região -- **Encontrar artistas e espaços** culturais locais -- **Participar de oportunidades** e editais -- **Conectar-se** com outros agentes culturais - -### Gestão Cultural Descentralizada -O Mapas Culturais facilita a gestão cultural descentralizada, permitindo que: - -- **Múltiplas entidades** contribuam com dados culturais -- **Grupos independentes** gerenciem suas informações -- **Secretarias de cultura** coordenem ações -- **Dados sejam atualizados** de forma distribuída - -### Gestão de Projetos e Eventos -A plataforma suporta: - -- **Registro de participantes** em eventos -- **Gestão de espaços** e recursos -- **Organização de atividades** culturais -- **Acompanhamento de projetos** aprovados - -### Transparência e Governo Aberto -Ao fornecer acesso aberto aos dados culturais, promove: - -- **Transparência** na administração pública -- **Participação cidadã** na governança cultural -- **Prestação de contas** de recursos públicos -- **Controle social** das políticas culturais - -## Exemplos de Implementações - -### Nível Federal e Internacional - -#### Brasil - Governo Federal -- **[SNIIC](http://mapas.cultura.gov.br/)** - Sistema Nacional de Informações e Indicadores Culturais -- **[Museus](http://museus.cultura.gov.br/)** - Cadastro Nacional de Museus -- **[Bibliotecas Públicas](http://bibliotecas.cultura.gov.br/)** - Sistema Nacional de Bibliotecas Públicas -- **[Cultura Viva](http://culturaviva.gov.br/)** - Programa Nacional Cultura Viva -- **[Pontos de Memória](http://pontosdememoria.cultura.gov.br/)** - Rede de Pontos de Memória - -#### Internacional -- **[IberculturaViva](https://mapa.iberculturaviva.org/)** - Rede Ibero-americana -- **[Mapa Uruguai](http://culturaenlinea.uy/)** - Sistema Nacional do Uruguai - -### Nível Estadual (Brasil) - -#### Região Centro-Oeste -- **[Distrito Federal](http://mapa.cultura.df.gov.br/)** - Secretaria de Cultura e Economia Criativa -- **[Goiás](https://mapagoiano.cultura.go.gov.br/)** - Mapa Goiano da Cultura - -#### Região Nordeste -- **[Ceará](https://mapacultural.secult.ce.gov.br/)** - Secretaria da Cultura do Estado -- **[Maranhão](https://mapadacultura.ma.gov.br/)** - Secretaria de Estado da Cultura - -#### Região Sudeste -- **[Espírito Santo](https://mapa.cultura.es.gov.br/)** - Secretaria da Cultura - -### Estatísticas de Adoção -Até as últimas informações disponíveis: -- **89+ instalações ativas** no Brasil e América Latina -- **Crescimento contínuo** de novas implementações -- **Comunidade ativa** de desenvolvedores e usuários - -## Comparação com Ferramentas Semelhantes - -### Plataformas GIS de Propósito Geral - -#### Exemplos: ArcGIS, QGIS, Google Maps Platform - -**Vantagens das ferramentas GIS:** -- Robustas capacidades de análise geoespacial -- Ferramentas avançadas de mapeamento -- Ampla gama de funcionalidades geográficas - -**Limitações para gestão cultural:** -- Não são projetadas especificamente para cultura -- Exigem personalização significativa -- Falta de modelos de dados culturais -- Ausência de fluxos de trabalho específicos - -**Diferencial do Mapas Culturais:** -- Solução pronta para uso no setor cultural -- Modelos de dados otimizados para cultura -- Fluxos de trabalho específicos do setor - -### Sistemas de Gestão de Conteúdo (CMS) - -#### Exemplos: WordPress com plugins de mapeamento - -**Vantagens dos CMS:** -- Flexibilidade para personalização -- Grande ecossistema de plugins -- Facilidade de uso para editores - -**Limitações para gestão cultural:** -- Carecem de recursos especializados -- Falta de edição colaborativa específica -- Ausência de integração com políticas públicas -- Estrutura de dados genérica - -**Diferencial do Mapas Culturais:** -- Organização de dados culturais especializada -- Relacionamentos otimizados para informações culturais -- Integração nativa com processos de fomento - -### Software de Gestão do Patrimônio Cultural - -#### Exemplos: CollectiveAccess, Omeka - -**Vantagens das ferramentas de patrimônio:** -- Projetadas para gerenciar coleções -- Foco em catalogação e preservação -- Recursos de arquivo e documentação - -**Limitações para gestão cultural dinâmica:** -- Foco principal em artefatos estáticos -- Limitadas capacidades de mapeamento -- Ausência de gestão de eventos e projetos - -**Diferencial do Mapas Culturais:** -- Ênfase na produção cultural dinâmica -- Gestão de eventos e agentes culturais vivos -- Foco em atividades culturais contemporâneas - -### Ferramentas de Mapeamento Participativo - -#### Exemplos: OpenStreetMap, Ushahidi - -**Vantagens das ferramentas participativas:** -- Coleta de dados impulsionada pela comunidade -- Modelo colaborativo aberto -- Facilidade de contribuição - -**Limitações para gestão institucional:** -- Falta de estrutura para gestão oficial -- Ausência de fluxos de trabalho institucionais -- Limitada integração com políticas públicas - -**Diferencial do Mapas Culturais:** -- Equilibra contribuições da base com supervisão institucional -- Estrutura para gestão oficial de informações -- Integração com processos de fomento cultural - -## Diferenciadores Chave do Mapas Culturais - -### 1. Especialização no Setor Cultural -- **Design específico** para necessidades culturais -- **Campos de dados** relevantes para o setor -- **Fluxos de trabalho** adaptados à gestão cultural -- **Terminologia** e conceitos do setor - -### 2. Ecossistema de Código Aberto -- **Transparência** total do código -- **Comunidade colaborativa** de desenvolvedores -- **Melhoria contínua** através de contribuições -- **Adaptação** às necessidades locais - -### 3. Integração com Políticas Públicas -- **Suporte a iniciativas** governamentais -- **Dados para formulação** de políticas -- **Transparência** nos processos públicos -- **Prestação de contas** de recursos - -### 4. Suporte a Múltiplas Autenticações -- **Integração** com sistemas governamentais -- **Login Cidadão** e outros provedores -- **Facilidade de acesso** para usuários -- **Segurança** e conformidade - -### 5. Arquitetura Modular e Extensível -- **Personalização** sem alterar o core -- **Plugins** para funcionalidades específicas -- **Temas** customizáveis por instituição -- **APIs** para integrações externas - -## Impacto e Resultados - -### Para o Setor Público -- **Melhoria na formulação** de políticas culturais -- **Otimização** na alocação de recursos -- **Aumento da transparência** governamental -- **Facilitation do controle social** - -### Para Agentes Culturais -- **Maior visibilidade** de projetos e eventos -- **Facilidade de acesso** a oportunidades -- **Networking** entre agentes do setor -- **Profissionalização** da gestão cultural - -### Para a Sociedade -- **Democratização** do acesso à informação cultural -- **Descoberta** de eventos e espaços locais -- **Participação** em atividades culturais -- **Fortalecimento** da identidade cultural local - -## Próximos Passos - -Para entender melhor a implementação técnica: - -1. **[Módulos e Funcionalidades](04_modulos_funcionalidades)** - Detalhes dos módulos disponíveis -2. **[Entidades](../02_guia_avancado_plataforma/01_entidades__entities__)** - Modelos de dados principais -3. **[Personalização](05_personalizacao_configuracao)** - Opções de customização - ---- - -*O sucesso das implementações demonstra a efetividade da plataforma em atender às necessidades reais do setor cultural.* diff --git a/content/docs/devs/00_visao_geral_plataforma/04_modulos_funcionalidades.mdx b/content/docs/devs/00_visao_geral_plataforma/04_modulos_funcionalidades.mdx deleted file mode 100644 index 0368ee9..0000000 --- a/content/docs/devs/00_visao_geral_plataforma/04_modulos_funcionalidades.mdx +++ /dev/null @@ -1,379 +0,0 @@ ---- -title: Módulos e Funcionalidades Essenciais -description: Detalhamento dos módulos disponíveis e suas implicações de negócios ---- - -# Módulos e Funcionalidades Essenciais - -A arquitetura modular do Mapas Culturais, evidente no diretório `src/modules`, permite uma plataforma flexível e extensível. Cada módulo geralmente encapsula um conjunto específico de funcionalidades, contribuindo para os recursos gerais do sistema. - -## Visão Geral da Arquitetura Modular - - - -## Módulos Principais - -### 1. Gestão de Usuários e Contas - -#### UserManagement -**Funcionalidade**: Gerenciamento completo do ciclo de vida dos usuários -- Registro e ativação de contas -- Perfis de usuário personalizáveis -- Gestão de permissões e papéis -- Histórico de atividades - -**Implicação de Negócios**: Permite controle granular sobre quem pode acessar e modificar informações na plataforma, essencial para governança de dados culturais. - -#### DeleteAccount -**Funcionalidade**: Conformidade com direito ao esquecimento -- Exclusão completa de dados pessoais -- Anonização de contribuições históricas -- Processo de confirmação seguro -- Logs de auditoria - -**Implicação de Negócios**: Garante conformidade com LGPD e outras regulamentações de privacidade, reduzindo riscos legais. - -#### FakeAuthentication -**Funcionalidade**: Sistema de autenticação para desenvolvimento e testes -- Simulação de diferentes tipos de usuário -- Testes automatizados de autorização -- Ambiente de desenvolvimento isolado -- Integração com CI/CD - -**Implicação de Negócios**: Acelera o desenvolvimento e garante qualidade através de testes automatizados. - -### 2. Gestão de Conteúdo e Entidades - -#### Entities -**Funcionalidade**: Modelos de dados centrais da plataforma -- Agentes (pessoas físicas e jurídicas) -- Espaços (locais culturais) -- Eventos (atividades culturais) -- Projetos (iniciativas de médio/longo prazo) -- Relacionamentos entre entidades - -**Implicação de Negócios**: Fornece a base estrutural para toda informação cultural, permitindo análises complexas e relatórios estratégicos. - -#### Apps -**Funcionalidade**: Aplicações específicas construídas sobre as entidades -- Interfaces especializadas por tipo de usuário -- Fluxos de trabalho customizados -- Integrações com sistemas externos -- Dashboards personalizados - -**Implicação de Negócios**: Permite adaptação da plataforma para diferentes contextos de uso sem modificar o core. - -#### Home -**Funcionalidade**: Gestão da experiência inicial do usuário -- Página inicial personalizável -- Destaques e notícias -- Onboarding de novos usuários -- Métricas de engajamento - -**Implicação de Negócios**: Melhora a adoção da plataforma e engajamento dos usuários através de uma primeira impressão positiva. - -### 3. Gestão de Oportunidades e Projetos - -#### Opportunities -**Funcionalidade**: Sistema completo de editais e chamadas públicas -- Criação e configuração de oportunidades -- Formulários dinâmicos de inscrição -- Gestão de prazos e fases -- Comunicação com proponentes - -**Implicação de Negócios**: Digitaliza e otimiza processos de fomento cultural, reduzindo custos administrativos e aumentando transparência. - -#### OpportunityPhases -**Funcionalidade**: Gestão de fases dos processos seletivos -- Definição de etapas sequenciais -- Critérios específicos por fase -- Transições automáticas e manuais -- Notificações de mudança de fase - -**Implicação de Negócios**: Permite processos seletivos complexos e transparentes, adequados a diferentes tipos de fomento cultural. - -#### OpportunityAccountability -**Funcionalidade**: Prestação de contas de projetos aprovados -- Relatórios de execução -- Comprovação de gastos -- Acompanhamento de metas -- Avaliação de resultados - -**Implicação de Negócios**: Garante o uso adequado de recursos públicos e fornece dados para avaliação de políticas culturais. - -#### OpportunityAppealPhase -**Funcionalidade**: Sistema de recursos e contestações -- Processo formal de recurso -- Análise por comissão especializada -- Prazos e procedimentos definidos -- Transparência nas decisões - -**Implicação de Negócios**: Assegura devido processo legal e reduz questionamentos judiciais sobre processos seletivos. - -#### OpportunityWorkplan -**Funcionalidade**: Gestão de planos de trabalho -- Cronogramas detalhados -- Marcos e entregas -- Acompanhamento de progresso -- Ajustes e reprogramações - -**Implicação de Negócios**: Melhora a execução de projetos culturais e facilita o monitoramento de resultados. - -#### ProjectMonitoring -**Funcionalidade**: Monitoramento contínuo de projetos -- Indicadores de performance -- Alertas de desvios -- Relatórios automáticos -- Dashboard executivo - -**Implicação de Negócios**: Permite intervenções proativas e melhora a taxa de sucesso dos projetos financiados. - -### 4. Processos de Avaliação e Seleção - -#### EvaluationMethodContinuous -**Funcionalidade**: Avaliação contínua de projetos -- Fluxo contínuo de inscrições -- Avaliação por ordem de chegada -- Critérios de elegibilidade automáticos -- Aprovação imediata quando possível - -**Implicação de Negócios**: Adequado para programas de fomento com recursos contínuos, reduzindo tempo de espera dos proponentes. - -#### EvaluationMethodDocumentary -**Funcionalidade**: Avaliação baseada em análise documental -- Checklist de documentos obrigatórios -- Validação automática de formatos -- Análise de conformidade -- Pontuação por critérios documentais - -**Implicação de Negócios**: Eficiente para processos que dependem principalmente de comprovação documental. - -#### EvaluationMethodQualification -**Funcionalidade**: Avaliação por qualificação técnica -- Análise de currículo e portfólio -- Critérios de experiência -- Pontuação por competências -- Ranking de qualificação - -**Implicação de Negócios**: Adequado para seleção de profissionais e projetos que exigem expertise específica. - -#### EvaluationMethodSimple -**Funcionalidade**: Avaliação simplificada -- Critérios básicos de elegibilidade -- Processo rápido de aprovação -- Mínima burocracia -- Foco na democratização do acesso - -**Implicação de Negócios**: Facilita o acesso a recursos para pequenos projetos e iniciativas comunitárias. - -#### EvaluationMethodTechnical -**Funcionalidade**: Avaliação técnica especializada -- Comissões de especialistas -- Critérios técnicos complexos -- Análise detalhada de propostas -- Pareceres fundamentados - -**Implicação de Negócios**: Garante qualidade técnica em projetos de maior complexidade e valor. - -### 5. Relatórios e Análise de Dados - -#### Reports -**Funcionalidade**: Sistema de relatórios customizáveis -- Relatórios pré-definidos -- Construtor de relatórios personalizado -- Exportação em múltiplos formatos -- Agendamento automático - -**Implicação de Negócios**: Fornece insights estratégicos para tomada de decisão e prestação de contas. - -#### Charts -**Funcionalidade**: Visualizações gráficas de dados -- Gráficos interativos -- Dashboards executivos -- Indicadores em tempo real -- Comparações históricas - -**Implicação de Negócios**: Facilita a compreensão de dados complexos e melhora a comunicação de resultados. - -#### Spreadsheets -**Funcionalidade**: Importação e exportação de dados -- Import/export Excel e CSV -- Validação de dados importados -- Templates padronizados -- Processamento em lote - -**Implicação de Negócios**: Facilita migração de dados e integração com sistemas legados. - -#### ApiKeywords -**Funcionalidade**: Gestão de palavras-chave para busca -- Indexação inteligente -- Sinônimos e termos relacionados -- Otimização de busca -- Analytics de termos - -**Implicação de Negócios**: Melhora a descoberta de conteúdo e experiência do usuário. - -#### Search -**Funcionalidade**: Motor de busca avançado -- Busca textual e geográfica -- Filtros múltiplos -- Busca facetada -- API de busca - -**Implicação de Negócios**: Essencial para descoberta de informações culturais e usabilidade da plataforma. - -### 6. Comunicação e Notificações - -#### MailNotification -**Funcionalidade**: Sistema de notificações por e-mail -- Templates personalizáveis -- Envio em lote -- Tracking de entrega -- Integração com provedores - -**Implicação de Negócios**: Mantém usuários engajados e informados sobre oportunidades e atualizações. - -#### Notifications -**Funcionalidade**: Sistema de notificações da plataforma -- Notificações em tempo real -- Preferências de usuário -- Histórico de notificações -- Integração com dispositivos móveis - -**Implicação de Negócios**: Melhora a experiência do usuário e garante que informações importantes sejam comunicadas. - -### 7. Personalização e Interface - -#### ThemeCustomizer -**Funcionalidade**: Personalização visual da plataforma -- Editor visual de temas -- Customização de cores e fontes -- Upload de logotipos -- Preview em tempo real - -**Implicação de Negócios**: Permite que cada instituição mantenha sua identidade visual, aumentando adoção e reconhecimento. - -#### Components -**Funcionalidade**: Biblioteca de componentes reutilizáveis -- Componentes Vue.js padronizados -- Design system consistente -- Documentação de componentes -- Testes automatizados - -**Implicação de Negócios**: Acelera desenvolvimento e garante consistência visual em toda a plataforma. - -### 8. Recursos Especializados - -#### GeoDivisions -**Funcionalidade**: Gestão de divisões geográficas -- Hierarquia territorial -- Mapas interativos -- Análise geoespacial -- Integração com dados oficiais - -**Implicação de Negócios**: Permite análises territoriais da cultura e planejamento baseado em localização. - -#### LGPD -**Funcionalidade**: Conformidade com Lei Geral de Proteção de Dados -- Gestão de consentimentos -- Relatórios de conformidade -- Anonização de dados -- Auditoria de privacidade - -**Implicação de Negócios**: Reduz riscos legais e demonstra compromisso com privacidade dos usuários. - -#### Support -**Funcionalidade**: Sistema de suporte ao usuário -- Central de ajuda -- Tickets de suporte -- Base de conhecimento -- Chat integrado - -**Implicação de Negócios**: Reduz custos de suporte e melhora satisfação dos usuários. - -#### FAQ -**Funcionalidade**: Perguntas frequentes dinâmicas -- FAQ categorizado -- Busca em perguntas -- Analytics de dúvidas -- Atualização colaborativa - -**Implicação de Negócios**: Reduz volume de suporte e melhora autonomia dos usuários. - -## Benefícios da Arquitetura Modular - -### Flexibilidade -- **Ativação seletiva** de módulos conforme necessidade -- **Customização** sem impacto no core -- **Evolução independente** de funcionalidades -- **Adaptação** a contextos específicos - -### Manutenibilidade -- **Responsabilidades bem definidas** por módulo -- **Testes isolados** e específicos -- **Atualizações seguras** sem quebrar funcionalidades -- **Debugging facilitado** - -### Escalabilidade -- **Distribuição de carga** por funcionalidade -- **Otimização específica** por módulo -- **Cache granular** por tipo de dados -- **Performance otimizada** - -### Extensibilidade -- **Novos módulos** sem modificar existentes -- **APIs padronizadas** para integração -- **Hooks e eventos** para customização -- **Ecossistema de plugins** - -## Próximos Passos - -Para aprofundar o conhecimento sobre implementação: - -1. **[Personalização e Configuração](05_personalizacao_configuracao)** - Opções de customização -2. **[Entidades](../02_guia_avancado_plataforma/01_entidades__entities__)** - Modelos de dados detalhados -3. **[Componentes Vue](../02_guia_avancado_plataforma/02_componentes_vue__vue_components__)** - Interface de usuário - ---- - -*A arquitetura modular é fundamental para a flexibilidade e sustentabilidade da plataforma Mapas Culturais.* diff --git a/content/docs/devs/00_visao_geral_plataforma/05_personalizacao_configuracao.mdx b/content/docs/devs/00_visao_geral_plataforma/05_personalizacao_configuracao.mdx deleted file mode 100644 index 222bf15..0000000 --- a/content/docs/devs/00_visao_geral_plataforma/05_personalizacao_configuracao.mdx +++ /dev/null @@ -1,402 +0,0 @@ ---- -title: Personalização e Configuração -description: Configurações de UI, comportamento e customização da plataforma ---- - -# Personalização e Configuração - -A capacidade de personalizar a interface do usuário (UI) e o comportamento da plataforma Mapas Culturais é crucial para atender às necessidades específicas de diferentes instituições e contextos culturais. Essas configurações permitem que as instâncias da plataforma se adaptem à identidade visual, aos fluxos de trabalho e aos requisitos de conteúdo de cada implementação. - -## Visão Geral da Personalização - - - -## Tipos de Configurações de Personalização - -### 1. Branding e Aparência Visual - -#### Logotipos e Identidade Visual - -**Funcionalidades disponíveis:** - -- Upload de logotipos personalizados (principal, secundário, favicon) -- Configuração de ícones para diferentes seções -- Imagens de fundo e banners customizáveis -- Watermarks e elementos de marca - -**Configuração técnica:** -```php -// Exemplo de configuração de logo -'app.logo' => [ - 'main' => '/uploads/logos/main-logo.png', - 'secondary' => '/uploads/logos/secondary-logo.png', - 'favicon' => '/uploads/logos/favicon.ico' -] -``` - -**Implicação de Negócios:** Permite que cada instituição mantenha sua identidade visual consistente, aumentando reconhecimento e credibilidade. - -#### Esquemas de Cores e Temas -**Funcionalidades disponíveis:** -- Definição de cores primárias e secundárias -- Paleta de cores personalizada -- Temas claro e escuro -- Customização de CSS avançada - -**Configuração técnica:** -```scss -// Variáveis de tema personalizadas -$primary-color: #2c5aa0; -$secondary-color: #f39c12; -$accent-color: #e74c3c; -$background-color: #ffffff; -$text-color: #333333; -``` - -**Implicação de Negócios:** Alinha a plataforma com guidelines de marca institucional e melhora experiência do usuário. - -#### Layout e Estrutura -**Funcionalidades disponíveis:** -- Configuração de cabeçalhos e rodapés -- Personalização de menus de navegação -- Ajustes de layout responsivo -- Configuração de sidebars e widgets - -**Implicação de Negócios:** Otimiza a experiência do usuário para diferentes contextos de uso e dispositivos. - -### 2. Conteúdo e Apresentação - -#### Campos Personalizados e Metadados -**Funcionalidades disponíveis:** -- Criação de campos específicos por tipo de entidade -- Validação customizada de dados -- Campos obrigatórios e opcionais -- Diferentes tipos de input (texto, número, data, arquivo, etc.) - -**Configuração técnica:** -```php -// Exemplo de campo personalizado -'custom_fields' => [ - 'agent' => [ - 'specialty' => [ - 'type' => 'select', - 'label' => 'Especialidade Artística', - 'options' => ['musica', 'teatro', 'danca', 'artes_visuais'], - 'required' => true - ] - ] -] -``` - -**Implicação de Negócios:** Permite coleta de informações específicas para cada contexto cultural, melhorando qualidade dos dados. - -#### Tipos de Entidades e Taxonomias -**Funcionalidades disponíveis:** -- Definição de novos tipos de entidades -- Criação de taxonomias personalizadas -- Categorização hierárquica -- Tags e palavras-chave específicas - -**Configuração técnica:** -```php -// Exemplo de taxonomia personalizada -'taxonomies' => [ - 'linguagem_artistica' => [ - 'label' => 'Linguagem Artística', - 'hierarchical' => true, - 'entities' => ['agent', 'project', 'event'] - ] -] -``` - -**Implicação de Negócios:** Organiza informações de forma relevante para cada contexto cultural e facilita busca e análise. - -#### Páginas Iniciais Personalizáveis -**Funcionalidades disponíveis:** -- Editor de conteúdo da página inicial -- Widgets configuráveis -- Destaques e notícias -- Chamadas para ação personalizadas - -**Implicação de Negócios:** Melhora primeira impressão e engajamento dos usuários. - -### 3. Fluxos de Trabalho e Processos - -#### Processos de Inscrição e Avaliação -**Funcionalidades disponíveis:** -- Configuração de etapas de inscrição -- Formulários dinâmicos personalizáveis -- Fluxos de aprovação customizados -- Critérios de avaliação específicos - -**Configuração técnica:** -```php -// Exemplo de configuração de processo -'opportunity_phases' => [ - 'inscricao' => [ - 'label' => 'Inscrição', - 'duration' => 30, // dias - 'required_fields' => ['project_description', 'budget'] - ], - 'avaliacao' => [ - 'label' => 'Avaliação', - 'evaluators' => 3, - 'criteria' => ['relevancia', 'viabilidade', 'impacto'] - ] -] -``` - -**Implicação de Negócios:** Adapta processos seletivos às especificidades de cada programa de fomento cultural. - -#### Notificações e Alertas -**Funcionalidades disponíveis:** -- Templates de e-mail personalizáveis -- Configuração de gatilhos automáticos -- Preferências de usuário -- Integração com sistemas externos - -**Configuração técnica:** -```php -// Exemplo de template de notificação -'notification_templates' => [ - 'opportunity_published' => [ - 'subject' => 'Nova oportunidade: {{opportunity.name}}', - 'body' => 'templates/emails/opportunity-published.html', - 'triggers' => ['opportunity.publish'] - ] -] -``` - -**Implicação de Negócios:** Mantém usuários informados e engajados com comunicação relevante e oportuna. - -#### Permissões e Papéis de Usuário -**Funcionalidades disponíveis:** -- Definição de papéis customizados -- Permissões granulares por funcionalidade -- Hierarquia de acesso -- Delegação de responsabilidades - -**Configuração técnica:** -```php -// Exemplo de configuração de papéis -'user_roles' => [ - 'gestor_cultural' => [ - 'label' => 'Gestor Cultural', - 'permissions' => [ - 'opportunity.create', - 'opportunity.manage', - 'evaluation.participate' - ] - ] -] -``` - -**Implicação de Negócios:** Garante segurança e controle adequado sobre informações sensíveis. - -### 4. Funcionalidades de Pesquisa e Filtragem - -#### Filtros Personalizados -**Funcionalidades disponíveis:** -- Configuração de filtros por categoria -- Filtros geográficos customizados -- Filtros por campos personalizados -- Salvamento de buscas favoritas - -**Configuração técnica:** -```php -// Exemplo de configuração de filtros -'search_filters' => [ - 'linguagem_artistica' => [ - 'type' => 'taxonomy', - 'label' => 'Linguagem Artística', - 'multiple' => true - ], - 'orcamento' => [ - 'type' => 'range', - 'label' => 'Faixa de Orçamento', - 'min' => 0, - 'max' => 1000000 - ] -] -``` - -**Implicação de Negócios:** Facilita descoberta de informações relevantes e melhora experiência do usuário. - -#### Palavras-chave e Tags -**Funcionalidades disponíveis:** -- Gestão de vocabulário controlado -- Sinônimos e termos relacionados -- Auto-sugestão de tags -- Analytics de termos de busca - -**Implicação de Negócios:** Melhora qualidade da busca e descoberta de conteúdo. - -### 5. Integração e Localização - -#### Integração com Sistemas Externos -**Funcionalidades disponíveis:** -- APIs para integração com sistemas legados -- Webhooks para sincronização de dados -- Conectores para plataformas de e-mail marketing -- Integração com ferramentas de análise - -**Configuração técnica:** -```php -// Exemplo de configuração de API externa -'external_apis' => [ - 'email_marketing' => [ - 'provider' => 'mailchimp', - 'api_key' => env('MAILCHIMP_API_KEY'), - 'list_id' => env('MAILCHIMP_LIST_ID') - ] -] -``` - -**Implicação de Negócios:** Permite aproveitamento de investimentos em sistemas existentes e melhora eficiência operacional. - -#### Configurações de Idioma -**Funcionalidades disponíveis:** -- Suporte a múltiplos idiomas -- Tradução de interface e conteúdo -- Localização de formatos (data, moeda) -- Configuração regional específica - -**Configuração técnica:** -```php -// Exemplo de configuração de localização -'localization' => [ - 'default_locale' => 'pt_BR', - 'available_locales' => ['pt_BR', 'es_ES', 'en_US'], - 'date_format' => 'd/m/Y', - 'currency' => 'BRL' -] -``` - -**Implicação de Negócios:** Permite uso da plataforma em diferentes contextos linguísticos e culturais. - -#### Configurações Regionais -**Funcionalidades disponíveis:** -- Adaptação a legislações locais -- Integração com bases de dados oficiais -- Configuração de divisões administrativas -- Adequação a práticas culturais locais - -**Implicação de Negócios:** Garante conformidade legal e relevância cultural em diferentes regiões. - -## Ferramentas de Personalização - -### Theme Customizer -**Interface visual para:** -- Edição de cores e fontes em tempo real -- Preview de mudanças antes da aplicação -- Backup e restauração de configurações -- Exportação/importação de temas - -### Configuration Manager -**Painel administrativo para:** -- Gestão centralizada de configurações -- Versionamento de configurações -- Aplicação de configurações em lote -- Auditoria de mudanças - -### Field Builder -**Construtor visual para:** -- Criação de campos personalizados -- Configuração de validações -- Definição de relacionamentos -- Testes de campos antes da publicação - -## Implicações de Negócios da Personalização - -### Adoção e Relevância -- **Maior taxa de adoção** através de relevância específica -- **Redução de resistência** à mudança -- **Aumento do engajamento** dos usuários -- **Melhoria na satisfação** geral - -### Eficiência Operacional -- **Otimização de processos** internos -- **Redução de trabalho manual** através de automação -- **Diminuição de erros** através de validações específicas -- **Melhoria na qualidade** dos dados coletados - -### Consistência da Marca -- **Reforço da identidade** institucional -- **Credibilidade aumentada** através de profissionalismo -- **Reconhecimento de marca** melhorado -- **Confiança do usuário** fortalecida - -### Flexibilidade e Escalabilidade -- **Adaptação a novos requisitos** sem desenvolvimento customizado -- **Crescimento sustentável** da plataforma -- **Evolução contínua** das funcionalidades -- **Redução de custos** de manutenção - -### Conformidade e Governança -- **Adequação a regulamentações** específicas -- **Controle de acesso** granular -- **Auditoria completa** de ações -- **Gestão de riscos** aprimorada - -## Melhores Práticas - -### Planejamento -- **Análise de requisitos** antes da implementação -- **Definição de prioridades** de personalização -- **Documentação** de configurações -- **Testes** em ambiente de desenvolvimento - -### Implementação -- **Mudanças graduais** para minimizar impacto -- **Backup** antes de alterações importantes -- **Monitoramento** de performance após mudanças -- **Treinamento** de usuários em novas funcionalidades - -### Manutenção -- **Revisão periódica** de configurações -- **Atualização** de personalizações com novas versões -- **Otimização contínua** baseada em uso -- **Documentação atualizada** de customizações - -## Próximos Passos - -Para implementar personalizações efetivas: - -1. **[Entidades](../02_guia_avancado_plataforma/01_entidades__entities__)** - Entender modelos de dados para customização -2. **[Componentes Vue](../02_guia_avancado_plataforma/02_componentes_vue__vue_components__)** - Personalizar interface de usuário -3. **[Oportunidades](../02_guia_avancado_plataforma/06_oportunidades_e_inscricoes__opportunities___registrations__)** - Configurar processos específicos - ---- - -*A personalização é fundamental para o sucesso da implementação da plataforma em diferentes contextos culturais.* diff --git a/content/docs/devs/00_visao_geral_plataforma/index.mdx b/content/docs/devs/00_visao_geral_plataforma/index.mdx deleted file mode 100644 index 58cecc3..0000000 --- a/content/docs/devs/00_visao_geral_plataforma/index.mdx +++ /dev/null @@ -1,122 +0,0 @@ ---- -title: Visão Geral da Plataforma -description: Arquitetura, tecnologias e conceitos fundamentais do Mapas Culturais ---- - -# Visão Geral da Plataforma Mapas Culturais - -O **Mapas Culturais** é uma plataforma colaborativa de código aberto projetada para coletar, organizar e disponibilizar informações sobre agentes culturais, espaços, eventos e projetos. Seu objetivo principal é fornecer às autoridades públicas uma visão abrangente da cultura local e aos cidadãos um mapa interativo dos espaços e eventos culturais. - -## Objetivos da Plataforma - -### Para Gestores Públicos -- **Visão estratégica** da cultura local através de dados estruturados -- **Formulação de políticas** baseada em evidências -- **Gestão de recursos** e programas culturais -- **Transparência** nos processos de fomento cultural - -### Para Cidadãos e Agentes Culturais -- **Descoberta** de eventos e espaços culturais -- **Cadastro e gestão** de informações culturais -- **Participação** em oportunidades e editais -- **Conexão** com outros agentes do setor - -## Arquitetura do Sistema - -A plataforma utiliza uma arquitetura moderna e escalável baseada em: - -### Backend (PHP) -- **Framework**: Slim Framework para APIs RESTful -- **ORM**: Doctrine para mapeamento objeto-relacional -- **Autenticação**: JWT e múltiplos provedores (OpenID, Login Cidadão) -- **Comunicação**: Symfony Mailer para notificações -- **Processamento**: PHPSpreadsheet para importação/exportação - -### Frontend (JavaScript) -- **Framework**: Vue.js para componentes interativos -- **Build**: Webpack com Laravel Mix -- **Estilização**: Sass/SCSS com PostCSS -- **Templating**: Mustache para renderização dinâmica - -### Banco de Dados -- **Principal**: PostgreSQL com extensões geoespaciais -- **Cache**: Redis para sessões e cache de dados -- **ORM**: Doctrine para abstração de dados - -## Conceitos Fundamentais - -### Entidades Principais - -1. **Agentes** - Pessoas físicas ou jurídicas do setor cultural -2. **Espaços** - Locais onde acontecem atividades culturais -3. **Eventos** - Atividades culturais com data e local específicos -4. **Projetos** - Iniciativas culturais de médio/longo prazo -5. **Oportunidades** - Editais, chamadas e processos seletivos - -### Relacionamentos -- Agentes podem ser **responsáveis** por espaços, eventos e projetos -- Eventos acontecem em **espaços** específicos -- Projetos podem gerar **eventos** e utilizar **espaços** -- Oportunidades podem financiar **projetos** e **eventos** - -## Módulos e Funcionalidades - -### Gestão de Conteúdo -- **Cadastro** e edição de entidades -- **Upload** e processamento de arquivos -- **Validação** de dados e integridade -- **Versionamento** de informações - -### Sistema de Busca -- **Busca textual** com indexação -- **Filtros geográficos** e por categorias -- **Busca avançada** com múltiplos critérios -- **API de busca** para integrações - -### Gestão de Oportunidades -- **Criação** de editais e chamadas -- **Processo de inscrição** online -- **Métodos de avaliação** configuráveis -- **Acompanhamento** de projetos aprovados - -### Painel de Controle -- **Dashboard** personalizado por usuário -- **Gestão** de entidades próprias -- **Notificações** e alertas -- **Relatórios** e estatísticas - -## Diferenciais Técnicos - -### Modularidade -- **Arquitetura modular** permite extensões -- **Plugins** para funcionalidades específicas -- **Temas** personalizáveis por instituição -- **APIs** para integrações externas - -### Escalabilidade -- **Separação** clara entre frontend e backend -- **Cache** inteligente para performance -- **Otimização** de consultas geoespaciais -- **Containerização** com Docker - -### Segurança -- **Autenticação** multi-fator -- **Autorização** baseada em papéis -- **Conformidade** com LGPD -- **Auditoria** de ações dos usuários - -## Próximos Passos - -Para aprofundar seu conhecimento sobre a plataforma: - -1. **[Funções e Tecnologias](00_visao_geral_plataforma/01_funcoes_tecnologias)** - Detalhes técnicos das dependências -2. **[Arquitetura do Sistema](00_visao_geral_plataforma/02_arquitetura_sistema)** - Diagramas e fluxos de dados -3. **[Casos de Uso e Implementações](00_visao_geral_plataforma/03_casos_uso_implementacoes)** - Exemplos reais de uso -4. **[Módulos e Funcionalidades](00_visao_geral_plataforma/04_modulos_funcionalidades)** - Detalhamento dos módulos -5. **[Personalização e Configuração](00_visao_geral_plataforma/05_personalizacao_configuracao)** - Opções de customização -6. **[Entidades](../02_guia_avancado_plataforma/01_entidades__entities__)** - Modelos de dados principais -7. **[Componentes Vue](../02_guia_avancado_plataforma/02_componentes_vue__vue_components__)** - Interface de usuário - ---- - -*Esta seção fornece uma base sólida para entender a plataforma. Continue explorando as seções específicas para detalhes de implementação.* diff --git a/content/docs/devs/00_visao_geral_plataforma/meta.json b/content/docs/devs/00_visao_geral_plataforma/meta.json deleted file mode 100644 index ab1dd5c..0000000 --- a/content/docs/devs/00_visao_geral_plataforma/meta.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "title": "Visão Geral", - "description": "Arquitetura, tecnologias e conceitos fundamentais", - "pages": [ - "01_funcoes_tecnologias", - "02_arquitetura_sistema", - "03_casos_uso_implementacoes", - "04_modulos_funcionalidades", - "05_personalizacao_configuracao" - ] -} diff --git a/content/docs/devs/01_guia_rapido_plataforma/01_introducao_praticas_cultura_colaborativa_software_livre.mdx b/content/docs/devs/01_guia_rapido_plataforma/01_introducao_praticas_cultura_colaborativa_software_livre.mdx deleted file mode 100644 index 9569f1f..0000000 --- a/content/docs/devs/01_guia_rapido_plataforma/01_introducao_praticas_cultura_colaborativa_software_livre.mdx +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Introdução das práticas da cultura colaborativa e do software livre -description: Arquitetura, tecnologias e conceitos fundamentais do Mapas Culturais ---- - - diff --git a/content/docs/devs/01_guia_rapido_plataforma/02_customizacao.mdx b/content/docs/devs/01_guia_rapido_plataforma/02_customizacao.mdx deleted file mode 100644 index b3bbdc6..0000000 --- a/content/docs/devs/01_guia_rapido_plataforma/02_customizacao.mdx +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Customização -description: Arquitetura, tecnologias e conceitos fundamentais do Mapas Culturais ---- - -# Customização diff --git a/content/docs/devs/01_guia_rapido_plataforma/03_suporte_tecnico_resolucao_problemas.mdx b/content/docs/devs/01_guia_rapido_plataforma/03_suporte_tecnico_resolucao_problemas.mdx deleted file mode 100644 index 789c00f..0000000 --- a/content/docs/devs/01_guia_rapido_plataforma/03_suporte_tecnico_resolucao_problemas.mdx +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Suporte Técnico e Resolução de Problemas -description: Arquitetura, tecnologias e conceitos fundamentais do Mapas Culturais ---- - -# Suporte Técnico e Resolução de Problemas diff --git a/content/docs/devs/01_guia_rapido_plataforma/04_gestao_dados.mdx b/content/docs/devs/01_guia_rapido_plataforma/04_gestao_dados.mdx deleted file mode 100644 index 3a5efe6..0000000 --- a/content/docs/devs/01_guia_rapido_plataforma/04_gestao_dados.mdx +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Gestão de dados -description: Arquitetura, tecnologias e conceitos fundamentais do Mapas Culturais ---- - -# Gestão de dados diff --git a/content/docs/devs/01_guia_rapido_plataforma/meta.json b/content/docs/devs/01_guia_rapido_plataforma/meta.json deleted file mode 100644 index de7b302..0000000 --- a/content/docs/devs/01_guia_rapido_plataforma/meta.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "title": "Guia Rápido", - "description": "Arquitetura, tecnologias e conceitos fundamentais", - "pages": [ - "01_introducao_praticas_cultura_colaborativa_software_livre", - "02_customizacao", - "03_suporte_tecnico_resolucao_problemas", - "04_gestao_dados" - ] -} diff --git a/content/docs/devs/02_guia_avancado_plataforma/01_entidades__entities__.mdx b/content/docs/devs/02_guia_avancado_plataforma/01_entidades__entities__.mdx deleted file mode 100644 index c4884b8..0000000 --- a/content/docs/devs/02_guia_avancado_plataforma/01_entidades__entities__.mdx +++ /dev/null @@ -1,248 +0,0 @@ ---- -title: Entidades -description: Chapter 1 ---- - -Neste primeiro capítulo, vamos explorar um dos conceitos mais fundamentais da nossa plataforma: as **Entidades**. - -## Para que servem as Entidades? - -Imagine que você está construindo um grande mapa cultural da sua cidade ou região usando peças de LEGO. Cada tipo de peça representa algo diferente: uma peça vermelha pode ser um museu, uma azul um artista, uma verde um show, e assim por diante. - -Na nossa plataforma, as **Entidades** são como essas peças de LEGO. Elas são a forma como o sistema representa os diferentes tipos de informações culturais importantes. Sem elas, não teríamos como organizar e conectar os dados sobre: - -* **Agentes:** Pessoas ou grupos (artistas, produtores culturais, coletivos). -* **Espaços:** Locais onde a cultura acontece (teatros, centros culturais, museus). -* **Eventos:** Acontecimentos culturais (shows, exposições, peças de teatro). -* **Projetos:** Iniciativas culturais. -* **Oportunidades:** Editais, chamadas públicas, prêmios. - -As Entidades são os "tijolos" essenciais que nos permitem construir o mapa cultural digital. Elas definem *o que* pode ser cadastrado na plataforma e *como* essas informações se relacionam. - -**Nosso Caso de Uso:** Como a plataforma representa e armazena as informações sobre um novo Centro Cultural que acabou de abrir na cidade? É isso que vamos entender! - -## Entendendo as Entidades - -Vamos detalhar um pouco mais: - -1. **O que é uma Entidade?** - É um objeto dentro do código que representa um item do mundo real (um agente, um espaço, etc.). Cada entidade guarda as informações específicas daquele item. Por exemplo, uma entidade do tipo "Espaço" vai guardar o nome do espaço, seu endereço, descrição, horário de funcionamento, etc. - -2. **Tipos de Entidades:** - Como vimos, existem tipos diferentes, cada um com seu propósito: `agent`, `space`, `event`, `project`, `opportunity`. Saber o tipo da entidade nos diz quais informações (propriedades) ela pode ter. - -3. **Propriedades:** - São os campos de informação de uma entidade. Pense como os campos de um formulário. Uma entidade `space` tem propriedades como `name` (nome), `shortDescription` (descrição curta), `location` (endereço), `terms` (termos como área de atuação). Uma entidade `event` terá propriedades como `name`, `occurrence` (datas e horários), `location`, etc. - -4. **Relações:** - Entidades não vivem isoladas! Elas se conectam. Um `event` pode acontecer em um `space`. Um `agent` pode ser o responsável por um `project`. Essas conexões são chamadas de relações e ajudam a construir a teia de informações culturais. - -## Usando Entidades na Prática - -No código da plataforma (especificamente no lado do navegador, o *frontend*), usamos uma classe JavaScript chamada `Entity` para trabalhar com esses dados. Essa classe nos ajuda a criar, ler, atualizar e deletar entidades. - -**Exemplo: Criando nosso Centro Cultural (Espaço)** - -Vamos ver como criar uma representação para o nosso novo Centro Cultural. Em algum lugar no código, provavelmente dentro de um [Componente Vue](02_componentes_vue__vue_components__.md) responsável por um formulário de cadastro, faríamos algo assim: - -```javascript -// 1. Importar a classe Entity (geralmente já está disponível globalmente) - -// 2. Criar uma nova instância de Entidade do tipo 'space' -// Note que ainda não tem ID, pois é novo. -const meuNovoEspaco = new Entity('space'); - -// 3. Preencher as propriedades (como preencher um formulário) -meuNovoEspaco.name = "Centro Cultural Vila das Artes"; -meuNovoEspaco.shortDescription = "Um novo espaço dedicado à arte e cultura local."; -// ... outras propriedades como endereço, tipo de espaço, etc. - -// 4. Salvar a entidade (enviar os dados para o servidor) -meuNovoEspaco.save().then(resposta => { - console.log("Espaço salvo com sucesso!", resposta); - // Agora 'meuNovoEspaco' provavelmente terá um ID e outras infos do servidor. -}).catch(erro => { - console.error("Ops, algo deu errado ao salvar:", erro); -}); -``` - -**O que acontece aqui?** - -1. `new Entity('space')`: Criamos um objeto "formulário" em branco, especificando que ele é para um `space`. -2. `meuNovoEspaco.name = ...`: Preenchemos os campos desse formulário virtual. -3. `meuNovoEspaco.save()`: Enviamos esse formulário preenchido para o "arquivo central" (o servidor, usando a [Classe API](03_classe_api_.md)). Se tudo der certo, o servidor confirma o salvamento e pode até nos devolver o número de identificação (ID) desse novo espaço. - -Você pode ver exemplos de como os componentes Vue usam a classe `Entity` para criar novos itens culturais nos arquivos como: - -* `modules/Entities/components/create-space/script.js`: Lida com a criação de Espaços. -* `modules/Entities/components/create-event/script.js`: Lida com a criação de Eventos. -* `modules/Entities/components/create-agent/script.js`: Lida com a criação de Agentes. -* `modules/Entities/components/create-project/script.js`: Lida com a criação de Projetos. -* `modules/Entities/components/create-opportunity/script.js`: Lida com a criação de Oportunidades. - -Esses scripts usam `new Entity(...)` e `entity.save()` de forma muito parecida com o exemplo acima, geralmente dentro de funções que são chamadas quando o usuário clica em botões como "Salvar Rascunho" ou "Publicar". - -## Por Dentro da Classe `Entity` - -Ok, mas o que acontece quando chamamos `new Entity()` ou `entity.save()`? Vamos espiar um pouco "debaixo do capô". - -**O Fluxo Simplificado:** - -1. **Interface do Usuário (Componente Vue):** O usuário preenche um formulário (por exemplo, para criar um novo Espaço) e clica em "Salvar". -2. **Componente Vue:** O código do componente pega os dados do formulário. -3. **Criação do Objeto `Entity`:** O componente cria uma instância da classe `Entity` (ex: `new Entity('space')`) e preenche suas propriedades com os dados do formulário. -4. **Chamada `save()`:** O componente chama o método `save()` no objeto `Entity`. -5. **Objeto `Entity`:** O método `save()` prepara os dados. -6. **Chamada à API:** O objeto `Entity` usa a [Classe API](03_classe_api_.md) para enviar os dados para o servidor (backend). -7. **Servidor (Backend):** Recebe os dados, valida, salva no banco de dados e envia uma resposta de volta (sucesso ou erro). -8. **Classe API:** Recebe a resposta do servidor. -9. **Objeto `Entity`:** A classe API repassa a resposta para o objeto `Entity`, que se atualiza (por exemplo, recebe o ID se for uma criação) ou registra erros. -10. **Interface do Usuário:** O componente Vue pode então mostrar uma mensagem de sucesso, fechar o formulário ou exibir erros. - -**Diagrama de Sequência (Simplificado):** - - - -**Mergulhando no Código (`modules/Components/assets/js/components-base/Entity.js`):** - -* **Construtor (`constructor`)**: - ```javascript - // Trecho simplificado do construtor - class Entity { - constructor(objectType, id, scope = 'default') { - this.__objectType = objectType; // Guarda o TIPO (agent, space, etc.) - this.id = id; // Guarda o ID (se já existir) - this.__scope = scope; // Contexto (geralmente 'default') - // ... outras inicializações (erros, mensagens) - } - // ... resto da classe - } - ``` - Quando fazemos `new Entity('space')`, esse código é executado para criar o objeto inicial, guardando que ele é do tipo `space`. - -* **Popular (`populate`)**: - ```javascript - // Trecho simplificado do populate - populate(obj, preserveValues = true) { - // Pega a descrição das propriedades e relações para este tipo de entidade - const __properties = this.$PROPERTIES; - const __relations = this.$RELATIONS; - - // Para cada propriedade definida para este TIPO de entidade... - for (let prop in __properties) { - // ... pega o valor vindo do 'obj' (geralmente dados do servidor) - let val = obj[prop]; - // ... (lógica para tratar datas, listas, etc.) ... - // Atualiza a propriedade no objeto 'this' (a própria entidade) - this[prop] = val; - } - // ... (lógica similar para relações, arquivos, etc.) ... - this.__originalValues = this.data(); // Guarda uma cópia para saber o que mudou - return this; - } - ``` - Esse método é usado para preencher o objeto `Entity` com dados, seja quando carregamos uma entidade existente do servidor ou após salvarmos uma nova e recebermos os dados completos de volta. - -* **Obter Dados (`data`)**: - ```javascript - // Trecho simplificado do data - data(onlyModifiedFields) { - const result = {}; - const $PROPERTIES = this.$PROPERTIES; - - // Para cada propriedade... - for (let prop in $PROPERTIES) { - // ... (ignora algumas propriedades internas como ID, timestamps) ... - let val = this[prop]; - // ... (lógica para formatar datas, etc.) ... - result[prop] = val; // Adiciona ao objeto de resultado - } - // ... (lógica similar para relações) ... - - // Se onlyModifiedFields for true, compara com __originalValues - // e remove os campos que não mudaram. - - return result; // Retorna um objeto simples com os dados prontos para enviar - } - ``` - Antes de salvar, o método `save()` chama `data()` para pegar apenas os dados que precisam ser enviados ao servidor, possivelmente filtrando apenas o que foi modificado. - -* **Salvar (`save`)**: - ```javascript - // Trecho simplificado do save - async save(delay = 300, preserveValues = true, forceSave) { - // ... (lógica de debounce para evitar saves múltiplos rápidos) ... - - return new Promise((resolve, reject) => { - // ... (guarda os callbacks resolve/reject) ... - - this.__saveTimeout = setTimeout(async () => { - try { - // Pega os dados a serem salvos (apenas modificados) - const data = this.data(true); - - // Se nada mudou, resolve a promessa imediatamente - if(JSON.stringify(data) == '{}' && !forceSave) { - // ... resolve ... - return; - } - - // Chama a API para persistir (salvar/atualizar) - const res = await this.API.persistEntity(this, forceSave); - - // Processa a resposta da API - this.doPromise(res, (entityData) => { - // Se sucesso, popula o objeto com os dados retornados - this.populate(entityData, preserveValues); - }).then(resolve).catch(reject); // Resolve ou rejeita a promessa original - - } catch (error) { - // ... trata erros ... - reject(error); - } - }, delay); - }); - } - ``` - O método `save()` orquestra o processo: pega os dados modificados usando `data()`, chama o método `persistEntity` da [Classe API](03_classe_api_.md) para fazer a comunicação real com o servidor, e depois processa a resposta usando `doPromise` (que por sua vez chama `populate` para atualizar o objeto local se o save for bem-sucedido). - -A classe `Entity` também possui muitos outros métodos úteis para lidar com diferentes aspectos das entidades, como: - -* `delete()`: Para marcar uma entidade como excluída. -* `publish()` / `unpublish()`: Para alterar o status entre rascunho e publicado. -* `upload()`: Para lidar com o envio de arquivos associados à entidade. -* Métodos para gerenciar relações (como `addAdmin`, `removeAgentRelation`, `createSealRelation`). - -## Conclusão - -Neste capítulo, aprendemos que as **Entidades** são os blocos de construção fundamentais da plataforma. Elas representam os principais tipos de dados culturais (Agentes, Espaços, Eventos, Projetos, Oportunidades) e suas características (propriedades) e conexões (relações). - -Vimos que a classe JavaScript `Entity` é a ferramenta principal no *frontend* para interagir com esses dados: criar novas entidades, preencher suas propriedades e salvá-las no servidor através da [Classe API](03_classe_api_.md). - -Entender as Entidades é crucial, pois elas são a base sobre a qual toda a informação da plataforma é organizada. - -No próximo capítulo, vamos ver como essas entidades são apresentadas e manipuladas na interface do usuário através dos [Componentes Vue (Vue Components)](02_componentes_vue__vue_components__.md). - ---- - -Generated by [AI Codebase Knowledge Builder](https://github.com/The-Pocket/Tutorial-Codebase-Knowledge) \ No newline at end of file diff --git a/content/docs/devs/02_guia_avancado_plataforma/02_componentes_vue__vue_components__.mdx b/content/docs/devs/02_guia_avancado_plataforma/02_componentes_vue__vue_components__.mdx deleted file mode 100644 index c14a2fd..0000000 --- a/content/docs/devs/02_guia_avancado_plataforma/02_componentes_vue__vue_components__.mdx +++ /dev/null @@ -1,315 +0,0 @@ ---- -title: Vue Components -description: Chapter 2 ---- - -No [Capítulo 1: Entidades (Entities)](01_entidades__entities__.md), vimos como a plataforma organiza as informações sobre agentes, espaços, eventos e outros itens culturais usando as Entidades. Criamos até uma representação para o nosso "Centro Cultural Vila das Artes". Mas como mostramos essas informações na tela para o usuário? É aí que entram os **Componentes Vue**! - -## Para que servem os Componentes Vue? - -Imagine que você tem as peças de LEGO (nossas Entidades) que representam o Centro Cultural. Agora, você precisa construir a *vitrine* onde essa peça será exibida no seu mapa cultural digital. Você não quer construir uma vitrine nova do zero toda vez que tiver um Centro Cultural, certo? Você quer um modelo de vitrine que possa ser reutilizado. - -Os **Componentes Vue** são exatamente isso: são como *modelos de vitrines* ou *blocos de construção* reutilizáveis para a interface do usuário (UI). Eles nos permitem pegar os dados de uma Entidade (como nosso Centro Cultural) e mostrá-los de forma organizada e bonita na tela. - -Cada componente cuida de uma parte específica da interface: - -* Um cartão para mostrar um resumo de uma entidade (`entity-card`). -* Um mapa interativo (`mc-map`). -* Abas para organizar conteúdo (`mc-tabs`). -* Um formulário para cadastrar um novo evento. -* Uma janela pop-up (`mc-modal`). - -Eles encapsulam o HTML, o JavaScript (lógica) e o CSS (estilo) necessários para aquela pequena parte da tela funcionar. Isso torna o desenvolvimento muito mais organizado, fácil de manter e rápido, pois podemos reutilizar esses blocos em vários lugares. No nosso projeto, os Componentes Vue são a tecnologia moderna que substitui a abordagem antiga baseada em AngularJS (usada na BaseV1). - -**Nosso Caso de Uso:** Como exibir as informações do nosso "Centro Cultural Vila das Artes" (a Entidade que criamos no capítulo anterior) em um cartão na página de resultados de busca? É isso que vamos entender! - -## Entendendo os Componentes Vue - -Vamos detalhar os ingredientes de um Componente Vue: - -1. **O que é um Componente Vue?** - É um pedaço autônomo e reutilizável da interface. Pense nele como um widget customizado. Ele tem sua própria estrutura (HTML), sua própria lógica (JavaScript) e seu próprio visual (CSS). - -2. **Estrutura (`