Boilerplat NextJs

Bem Vindo a o Boilerplate em NextJS

🚀 Sobre o Projeto

Este e um boilerplate em Next.js usado em meus projetos.

🎨 Layout

Geração de Componentes	Storybook	Teste unitarios

🔨 Tecnologias:

• TypeScript
• NextJS
• Styled Components
• Jest
• React Testing Library
• Storybook
• Eslint
• @alquipo/eslint-config
• Prettier
• Husky
• git-commit-msg-linter
• PlopJS

🔎 Comandos

• dev: Executa a aplicação em localhost:3000
• build: Cria a Build do projeto
• start: Inicia um servidor simples com o código de produção
• lint: Executa o Linter em todos os componentes e páginas
• test: Executa Jest para testar todos os componentes e páginas
• test:watch: Executa Jest em watch mode
• storybook: Executa Storybook em localhost:6006
• build-storybook: Cria uma build do storybook
• generate: Cria automaticamente um componente

🚀 Como rodar este projeto

Para clonar e executar este aplicativo, você precisará de Git e NodeJs Instalado em seu computador.

♾️ Usando create-next-app CLI (melhor forma)

# run project create-app-next cli
$ yarn create next-app -e https://github.com/Alquipo/boilerplate

🌀 Clonando o repositório

# Clone este repositório
$ git clone https://github.com/Alquipo/boilerplate-nextjs

# Acesse a pasta do projeto no terminal/cmd
$ cd boilerplate-nextjs

🎲 Rodando a Aplicação

# Instale as dependências
$ yarn install

# Execute a Aplicação em Desenvolvimento
$ yarn dev

# O servidor inciará na porta:3000 - acesse http://localhost:3000

💾 Comandos Úteis

#Criação de um componente completo com (index.tsx / stories.tsx / styles.ts / test.tsx)
$ yarn generate ComponentName

🤔 Como contribuir para o projeto

• Faça um fork do projeto;
• Crie uma nova branch com as suas alterações: git checkout -b my-feature
• Salve as alterações e crie uma mensagem de commit contando o que você fez:git commit -m "feature: My new feature"
• Envie as suas alterações: git push origin my-feature

Caso tenha alguma dúvida confira este guia de como contribuir no GitHub

📝 Licença

Este projeto esta sobe a licença MIT. Veja a LICENÇA para saber mais.

Feito com ❤️ por Alquipo Neto 👋🏽 Entre em contato!