Estrutura do Site
Wiki Primeiros passos #253
Estrutura do site
João Borsoi, #253, maio 2017Palavras-chave: arquivos, estrutura
Os sitemas e website desenvolvidos com o avalanche possuem um frontend desenvolvido em AngularJS/AngularStrap, que pode ser disponibilizado através de um webserver ou através de um aplicatível móvel. O frontend se comunica com um backend em PHP através de APIs RESTFul.
O site normalmente possue a seguinte estrutura de arquivos:
admin
Esta pasta contem arquivos de configurações e bibliotecas utilizadas pelo backend. Na versão mais atual do backend do avalanche, este é composto por APIs RESTful.
config
Esta pasta contém os arquivos de configuração do backend, no formato XML. O padrão para nome do arquivo é CMS_Config.xsm. Este arquivo possui opções de configuração como credenciais de acesso ao banco de dados, especificação dos diretórios utilizados pelo backend, e outros parâmetros de configurações utilizados pelos diversos módulos do avalanche
lib
Esta pasta deve conter as bibliotecas customizadas do aplicativo. Estas podem ser bibliotecas de terceiros, normalmente configuradas com o Composer e que ficam disponíveis dentro de uma subpasta vendor, ou podem ser novos módulos customizados do avalanche.
log
Esta pasta contém o arquivo de log do avalanche. Através do parâmetro logDBOper da seção debug no arquivo de configuração, o arquivo de log pode conter todas as operações de banco de dados. Senão, somente os erros e informações específicas serão registrados.
pages
Esta pasta contém as páginas específicas do backend. Cada página normalmente é responsável por tratar uma API RESTful, devendo retornar conteúdo em formato JSON.
scripts
Esta pasta contém todos os scritps SQL utilizados para criação e manutenção do banco de dados, assim como o dump da base (CMS_DBDump.sql). Todas as alterações no banco de dados constumam ser registradas nestes scritps para permitir serem aplicados em bases diferentes, por exemplo, numa base de desenvolvimento e numa base de produção.
tmp
Pasta para arquivos temporários.
api
Esta é a pasta de entrada para a API, acessade pelo servidor web (DocumentRoot). Contem basicamente um arquivo index.php que carrega as demais bibliotecas tanto do avalanche como as customizadas do próprio sistema (pasta admin acima), conforme a necessidade. Além deste arquivo pode conter arquivos estáticos, como por exemplo o arquivo que identifica estatos fixos do frontend (ui-router).
bin
Pasta com shell scripts para criação e backup (dump) do banco de dados.
ui
Pasta contendo o frontend do aplicativo (user interface). O Bower é utilizado como gerenciador de pacotes do frontend, e o gulp para automatizar o processos para geração do frontend a partir dos arquivos fontes.
src
Pasta contendo os fontes que são utilizados pelo gulp para geração do frontend. Dentro desta pasta existem subpastas de acordo com o tipo dos arquivos (css, html, js, less, sass e templates).
Comentários
Documentos Relacionados
-
João Borsoi março 2010