NextJS Gok Boilerplate

Este boilerplate visa otimizar a criação de novas aplicações já que o mesmo possui toda uma arquitetura e configurações pré-definidas.

Este projeto utiliza:

• TypeScript
• NextJS
• Styled Components
• Jest
• React Testing Library
• Storybook
• Eslint
• Prettier
• Husky

Criar um novo projeto utilizando o boilerplate

yarn create next-app -e https://github.com/gok-dev/next-gok-boilerplate

Começando

Primeiro, rode o servidor em modo desenvolvimento:

yarn dev

Abra http://localhost:3000 no seu navegador para ver o resultado.

Você pode começar a editar a pagina em pages/index.js. A pagina é atualizada automaticamente enquanto você edita.

Comandos

• dev: roda a aplicação em modo de desenvolvimento em localhost:3000
• build: cria uma versão de produção
• start: inicia um servidor simples com o build de produção
• lint: roda o lint em todas as paginas e componentes
• test: roda os testes em todas as paginas e componentes
• test:watch: inicia o jest no modo que fica escutando alterações no código
• storybook: inicia o storybook em localhost:6006
• build-storybook: cria uma versão de distribuição do storybook

Contribuição

Contribuições são o que fazem a comunidade open source um lugar incrível para aprender, inspirar e criar. Qualquer contribuição que você fizer será muito apreciada.

1. Faça um Fork do projeto
2. Crie uma Branch para sua Feature (git checkout -b feature/FeatureIncrivel)
3. Adicione suas mudanças (git add .)
4. Comite suas mudanças (git commit -m 'Adicionando uma Feature incrível!)
5. Faça o Push da Branch (git push origin feature/FeatureIncrivel)
6. Abra um Pull Request

Licença

Distribuído sob a licença MIT. Veja LICENSE para mais informações.

Contato

Gok - One Step Ahead - Github - [email protected]