Aqui está a versão atualizada da documentação com a estrutura correta de diretórios:
📌 Documentação da Estrutura do Diretório src
🔍 Visão Geral
Esta página tem como objetivo documentar detalhadamente todos os arquivos e diretórios contidos na pasta src
do projeto. Com essa documentação, buscamos tornar o código mais compreensível e facilitar sua manutenção.
📂 Estrutura do Diretório src
Abaixo está um resumo da organização da pasta src
e suas respectivas funções dentro do projeto:
src/
│── acess/ # Arquivos relacionados ao controle de acesso e permissões
│── app/ # Configuração principal e lógica da aplicação
│── blocks/ # Componentes modulares reutilizáveis
│── collections/ # Coleções de dados e lógica de manipulação
│── components/ # Componentes reutilizáveis da aplicação
│── hooks/ # Hooks personalizados para lógica de estado
│── lib/ # Bibliotecas e funcionalidades adicionais
│── utils/ # Funções utilitárias auxiliares
📜 Documentação dos Arquivos
📁 acess/
Contém arquivos e funções relacionadas à segurança e controle de acesso.
auth.js
→ Funções para autenticação de usuários e gerenciamento de sessão.permissions.js
→ Funções para verificar permissões de usuários.
📁 app/
Armazena a configuração principal e lógica da aplicação.
App.js
→ Componente raiz que configura e gerencia o estado global da aplicação.Router.js
→ Configuração das rotas e navegação da aplicação.
📁 blocks/
Contém componentes modulares que podem ser reutilizados em diferentes partes da aplicação.
Card.js
→ Componente de cartão com informações dinâmicas.Modal.js
→ Componente de modal reutilizável para exibição de conteúdo dinâmico.
📁 collections/
Contém coleções de dados e a lógica para manipulação dessas coleções.
users.js
→ Lógica de manipulação e filtragem de dados de usuários.products.js
→ Funções relacionadas ao gerenciamento de produtos no sistema.
📁 components/
Componentes reutilizáveis da aplicação, como botões, cabeçalhos, etc.
Button.js
→ Componente de botão personalizado.Header.js
→ Componente de cabeçalho da aplicação.
📁 hooks/
Hooks personalizados para gerenciar o estado e os efeitos colaterais.
useAuth.js
→ Hook para gerenciar autenticação e sessão de usuários.useFetch.js
→ Hook para realizar requisições HTTP de forma simplificada.
📁 lib/
Bibliotecas e funcionalidades adicionais utilizadas no projeto.
api.js
→ Funções auxiliares para interagir com a API externa.utils.js
→ Funções utilitárias gerais usadas em todo o projeto.
📁 utils/
Funções utilitárias para realizar tarefas comuns.
formatDate.js
→ Função para formatar datas de forma personalizada.cn.js
→ Função para manipulação de classes CSS de forma eficiente.