Guia Técnico: Instalação e Configuração do Projeto Tangent

O Tangent é um projeto de código aberto estruturado como um monorepo, o que significa que ele gerencia múltiplos pacotes e aplicações dentro de um único repositório Git. Sua arquitetura é fundamentada em tecnologias modernas de desenvolvimento web e desktop, visando performance e manutenibilidade.

Stack Tecnológica

  • TypeScript: Utliizado como linguagem principal para garantir tipagem estática e reduzir erros em tempo de execução.
  • Svelte: Framework responsável pela construção de interfaces reativas, compilando o código em tempo de build para otimizar o desempenho no navegador.
  • SCSS: Pré-processador CSS que faccilita a gestão de estilos complexos através de variáveis e aninhamento.
  • Electron: Framework que permite a execução da aplicação web como um software desktop nativo.

Pré-requisitos do Sistema

Antes de iniciar o processo de build, é fundamental ter as seguintes ferramentas configuradas no seu ambiente de desenvolvimento:

  • Node.js: Recomenda-se o uso de versões LTS (Long Term Support).
  • Git: Essencial para o controle de versão e gerenciamento de subcomponentes.

Para verificar se as ferramentas estão prontas para uso, execute os comandos abaixo no terminal:

# Verificação de versões instaladas
node --version
git --version

Procedimentos de Instalação

Siga a sequência abaixo para configurar o ambiente local:

1. Clonagem do Repositório

Baixe o código-fonte e acesse o diretório principal do projeto:

git clone https://github.com/suchnsuch/Tangent.git
cd Tangent

2. Inicialização de Submódulos

Como o Tangent utiliza dependências externas via Git, é necessário sincronizar os submódulos recursivamente:

git submodule update --init --recursive

3. Instalação de Dependências

Para garantir que o ambiente seja idêntico ao definido no arquivo de lock, utilize o comando ci do npm:

npm ci

4. Compilação do Projeto

Execute o processo de build para transformar os arquivos TypeScript e Svelte em código executável:

npm run build

Execução da Aplicação

A aplicação principal reside no pacote Electron. O comando para iniciar o ambiente de desenvolvimento varia conforme o sistema operacional:

Para usuários de macOS ou Linux:

cd apps/tangent-electron
npm run dev

Para usuários de Windows:

cd apps/tangent-electron
npm run dev:win

Estes comandos iniciarão o processo de hot-reload, permitindo que alterações no código sejam refletidas instantaneamente na interface do Electron.

Tags: TypeScript Svelte Electron monorepo SCSS

Publicado em 7-21 06:58