Visão Geral da Estrutura de Diretórios

Antes de mergulhar no FastUI, é essencial entender a organização dos arquivos do projeto. Esta seção detalha as pastas e arquivos principais.

Diretórios Principais

• demo: Contém exemplos de demonstração para visualizar o FastUI em ação.
• docs: Armazena toda a documentação, incluindo guias de desenvolvimento e FAQs.
• requirements: Lista as dependências necessárias, tipicamente em um arquivo requirements.txt.
• src: Local principal do código-fonte, onde ocorre a maior parte do desenvolvimento.
• eslintrc.cjs: Configura as regras do ESLint para verificação de código e padronização.
• gitignore: Especifica arquivos e diretórios ignorados pelo controle de versão, como builds e logs.
• pre-commit-config.yaml: Define ganchos pré-commit para tarefas automatizadas antes de commits.
• prettierignore: Indica arquivos excluídos da formatação pelo Prettier.
• LICENSE: Detalha a licença de uso do software.
• Makefile: Oferece comandos para automatizar tarefas de construção, como compilação e testes.
• README.md: Fornece uma introdução rápida, passos de instalação e recursos úteis.

Arquivos Específicos de Destaque

• build-docs.sh: Script para gerar documentação automaticamente.
• bump_npm.py: Auxilia na atualização de versões de pacotes npm.
• mkdocs.yml: Configura o MkDocs para geração de documentação HTML.
• package-lock.json e package.json: Gerenciam dependências e metadados de pacotes Node.js.
• pyproject.toml: Define o sistema de construção e dependências para o projeto Python.
• screenshot.png: Oferece uma captura de tela da interface do aplicativo.
• tsconfig.json: Configura as opções de compilação do TypeScript.
• typedoc.*: Arquivos para gerar documentação de API com TypeDoc.

Processo de Inicialização

Iniciar o projeto FastUI envolve várias etapas para configurar o ambiente corretamente.

Passo 1: Clonar o Repositório

Obtenha uma cópia local do repositório usando o comando Git:

git clone https://github.com/pydantic/FastUI.git
cd FastUI

Passo 2: Instalar Dependências Python

Cetrifique-se de que todas as bibliotecas Python necessárias estejam instaladas:

pip install -r requirements.txt

Passo 3: Configurar Dependências Frontend

O FastUI inclui componentes frontend em JavaScript/TypeScript, então instale os pacotes npm:

npm install

Passo 4: Executar a Aplicação

Inicie o servidor de desenvolvimento com o comando:

python src/app.py  # ou o ponto de entrada principal definido

Isso ativará o servidor na porta padrão, acessível via http://localhost:8000 no navegador.

Análise dos Arquivos de Configuração

Configurações permitem adaptar o projeto a diferentes ambientes. O FastUI utiliza arquivos-chave para personalização.

Configuração Python: pyproject.toml

Este arquivo define metadados do projeto, requisitos de construção, dependências e detalhes de plataforma. Por exemplo, pode especificar a versão mínima do Python suportada.

Configuração Node.js e TypeScript: tsconfig.json

Controla as opções do compilador TypeScript, como alvo de compilação, localização dos arquivos fonte e diretórios de saída.

Geração de Documentação: mkdocs.yml

Especifica a estruutra da documentação, temas, menus de navegação e plugins adicionais para o MkDocs.

Outras configurações, como arquivos .env para variáveis de ambiente sensíveis, podem ser usadas conofrme necessário.