/portal-ascepa

Portal Web da Ascepa - Associação de e para Cegos do Pará

Primary LanguageTypeScriptMIT LicenseMIT

ascepa logo

GitHub Actions Workflow Status GitHub last commit Static Badge Quality Gate Status

Home Page | Documentação | Wiki | Discussions


Bem-vindo ao repositório do Portal ASCEPA! Este projeto é uma parceria entre a ONG Associação de e para Cegos do Pará e TechExperts.Pro para melhorar a presença online e a experiência do usuário, focando em fornecer uma plataforma abrangente para membros, associados e visitantes.


Pré requisitos

  • Node v20+
  • Npm v10+
  • Git v2+

⚡ Início rápido

  1. Faça o clone da aplicação
git clone git@github.com:techexpertspro/portal-ascepa.git
  1. Instale as dependências do projeto
npm install
  1. Rode no terminal para iniciar o servidor local
npx nx serve portal-ascepa
  1. Para build de produção (dist/ ou build/), execute no terminal
npx nx build portal-ascepa
  1. Para visualizar o gráfico da estrutura de trabalho do projeto, execute no terminal
npx nx graph

Conecte-se conosco

Para dúvidas, feedbacks ou sugestões você pode abrir uma issue diretamente no nosso projeto, ou acessar nossa plataforma:

Como contribuir

Para contribuir acesse nosso guia de contribuição disponibilizado no CONTRIBUTING.md

Testes Unitários

O monorepo do Portal ASCEPA inclui módulos chamados home, layout e shared-ui. Para garantir a qualidade e a integridade do código, é essencial executar testes unitários regularmente. Abaixo estão os comandos para executar os testes de cada módulo individualmente, além de informações úteis sobre as flags que podem ser usadas.

Executando Testes Unitários

Rodando todos os testes:

Para rodar os testes unitários de todos os módulos no monorepo de uma vez, utilize:

npx nx test

Testando um módulo específico:

Para executar testes unitários de um módulo específico, como home, layout ou shared-ui, utilize o seguinte comando, substituindo pelo nome do módulo desejado:

npx nx test <module>

Exemplo para testar o módulo home:

npx nx test home

Flags Úteis para Testes

--watch: Use esta flag para rodar os testes em modo de observação. Isso permite que os testes sejam executados automaticamente sempre que uma mudança no código é detectada. Muito útil durante o desenvolvimento ativo!

npx nx test <module> --watch

--code-coverage: Para gerar um relatório de cobertura de código e identificar quais partes do código não foram cobertas pelos testes, utilize:

npx nx test <module> --code-coverage

O relatório de cobertura será gerado na pasta coverage dentro da pasta do módulo.

--runInBand: Executa os testes sequencialmente em vez de em paralelo. Esta flag é útil se você estiver enfrentando problemas relacionados à concorrência de recursos, como uso de memória.

npx nx test <module> --runInBand

--only-failures: Roda apenas os testes que falharam na última execução, economizando tempo ao corrigir falhas específicas.

npx nx test <module> --only-failures

Contribuidores ❤️

Licença

Licensed under the MIT License, Copyright ©2024 - TechExperts.Pro