Projeto de Estudo NodeJs e Typescript

1. ⤴️ Índice
2. 📗 Sobre
3. 📷 Imagens
4. 💻 Instalação
5. 📊 Diagrama
6. 🔨 Ferramentas
7. 👏 Boas Práticas
8. 🤓 Para Desenvolvedores
9. 🔢 Versões
10. 🤖 Uso de IA

Front-end de sistema de Negociações puramente didático

Este projeto tem como objetivo me atualizar em JavaScript/TypeScript no contexto de desenvolvimento front-end (diretório packages/negociacoes-site). O foco é o aprendizado e a aplicação de boas práticas utilizando TypeScript, sem o uso de frameworks como React, Vue, Nest, Next, entre outros. O projeto é baseado na Formação Melhore sua experiência de desenvolvimento com TypeScript e em trilhas de atualização.

Além disso, foi realizada dockerização do projeto (a arquitetura original era voltada apenas para fins didáticos) para testar o Github Codespaces, uma solução que permite validar e compartilhar o projeto na nuvem durante o desenvolvimento.

Está nos planos atualizar o packages/negociacoes-api, que atualmente é um mero exemplo para servir o front-end, para algo mais funcional, como uma prova de conceito (POC). Paralelamente, também estou pesquisando outras soluções para projetos de microsserviços mais complexos que estou desenvolvendo.

⤴️ voltar

⤴️ voltar

Para executar o projeto, siga as instruções abaixo:

1. Faça o download/clone do repositório do projeto.
2. Certifique-se de ter o Docker Compose instalado em sua máquina.
3. Execute na raiz do projeto, o comando docker-compose up ou docker compose up, dependendo da versão do Docker Compose instalada.
4. Acesse http:https://localhost:3000 em seu navegador para visualizar o projeto. Ele utiliza as portas 3000 e 3001 para a execução.

⤴️ voltar

O diagrama abaixo ilustra a arquitetura do projeto:

graph LR

subgraph User
  A[Cliente Web] -->|HTTP| B[negociacoes-site]
end

subgraph Backend
  B -->|HTTP| C[negociacoes-api]
end

subgraph Database
  E[negociacoes-api DB] -->|POSTGRESS| C
end

⤴️ voltar

As seguintes ferramentas foram usadas na construção do projeto:

• Node.js
• Express
• TypeScript
• npm
• NX
• Docker

⤴️ voltar

Seguindo boas práticas de desenvolvimento:

• Semantic Versioning 2.0.0
• keep a changelog
• Conventional Commits
• Mermaid Diagrams
• Monorepo

⤴️ voltar

Durante o estudo/desenvolvimento, por sugestão de outros desenvolvedores, foram adotadas as ferramentas Nx (que requer Nodejs em sua máquina) e seu console no VScode para a gestão de Monorepos. Estou utilizando o mínimo de suas capacidades com finalidade de estudo, no entanto para uma experiência de desenvolvimento e validação técnica do repositório, sugiro instalação do ambiente. Explicar o funcionamento do Nx não é o objetivo do presente documento, mas encorajo a buscar esses dados caso deseje. Qualquer Monorepo pode se tornar um monorepo Nx.

Nada do que foi discutido nessa seção deve atrapalhar o correto funcionamento e instalação do projeto em uma máquina com o docker-compose funcional

Tenha bons estudos :)

⤴️ voltar

As tags de versões estao sendo criadas manualmente a medida que os estudos avançam com melhorias notáveis no projeto. Cada novo modulo do curso ou funcionalidade é desenvolvido em uma branch a parte quando finalizadas é gerada tag (minor para o curso e patch para melhorias) e mergeadas em master.

Com a adição do Nx e futuramente um script de controle de versão esse processo tende a ser automatizado

Para obter mais informações, consulte o Histórico de Versões.

⤴️ voltar

O cabeçalho desta página foi criado com auxílio de inteligência artificial e um mínimo de retoque e construção no Gimp

Foram utilizados os seguintes prompts para sua criação no Bing IA:

IA também é utilizada em minhas pesquisas e estudos como ferramenta de apoio; no entanto, artes e desenvolvimento são, sobretudo, atividades criativas humanas.

Contrate artistas para projetos comerciais ou mais elaborados e Aprenda Engenhosidade!

⤴️ voltar