Skip to content

danielalves96/gamers-club-test

Repository files navigation

Gamersclub-test


Aplicação desenvolvida para GamersClub - FrontEnd
Esta aplicação foi desenvolvida apenas para prova de conhecimento e não é oficical da empresa GamersClub.

Aplicação em produção: gamers-club-test.com.br

Desenvolvido por Daniel Luiz Alves.

Tecnologias

  • ⚡️ Next.js 12
  • ⚛️ React 18
  • ⛑ TypeScript
  • 📏 ESLint — Para encontrar e corrigir problemas no código
  • 💖 Prettier — Formatador de código para estilo consistente
  • 🐶 Husky — Para executar scripts antes de commitar alterações
  • 🚓 Commitlint — Para garantir que as mensagens de commit sigam a convenção
  • 🖌 Renovate — Para manter as dependências atualizadas
  • 🚫 lint-staged — Executa o ESLint e Prettier em arquivos Git preparados
  • 👷 PR Workflow — Executa verificação de tipo e linters em solicitações pull
  • ⚙️ EditorConfig — Estilos de codificação consistentes entre editores e IDEs

Executando o projeto

Realize o download do projeto:

git clone https://github.com/danielalves96/gamers-club-test.git

Para instalar as dependências do projeto execute o seguinte comando:

yarn install

Desenvolvimento

Para rodar o projeto em modo de desenvolvimento, execute o comando abaixo para inicializar as variáveis de ambiente:

cp .env.example .env

Por fim, execute:

yarn dev

Abra http://localhost:3000 em seu navegador e veja o resultado.

Testes

Para executar os testes basta executar o comando:

yarn test

Documentação

Requisitos

  • Node.js >= 12.22.0
  • yarn

Estrutura de pastas

  • .github — Configuração do GitHub, incluindo o CI Workflow.
  • .husky — Configuração do Husky e hooks.
  • public — Arquivos estáticos, como robots.txt, imagns, e favicon.
  • src — Código fonte da aplicação, incluindo páginas, componentes, estilos.

Scripts

  • yarn dev — Inicia o aplicativo no modo de desenvolvimento em http://localhost:3000.
  • yarn build — Cria uma compilação de produção otimizada do seu aplicativo.
  • yarn start — Inicia a aplicação no modo de produção.
  • yarn type-check — Valide o código usando o compilador TypeScript.
  • yarn lint — Executa o ESLint para todos os arquivos no diretório src.
  • yarn format — Executa o Prettier para todos os arquivos no diretório src.
  • yarn test — Executa os testes da aplicação.

Licença

Este projeto está licenciado sob a Licença MIT - veja o arquivo LICENSE.md para mais informações.