Boilerplate: Next.js 13 + Tailwind + Jest + Storybook

💻 Projeto

Esse é um boilerplate que será usado para o desenvolvimento dos meus próximos projetos pessoais. Nele, imprementei as principais tecnologias e ferramentas que aprendi durante o tempo de estudo, criando um ambiente inicial de desenvolvimento padronizado, organizado e de fácil uso, podendo assim, iniciar rapidamente qualquer novo projeto, que use essas tecnologias, sem a necessidade de configura-las.

🚀 Tecnologias

Esse setup inicial conta com as seguintes tecnologias:

• NextJS 13
• TypeScript
• TailwindCSS
• Jest
• React Testing Library
• Storybook
• Plop
• Husky
• Lint Staged
• Commitlint
• Eslint
• Prettier
• Github Actions

👩🏽‍💻 Como usar ?

Pré-requisitos

Antes de baixar o projeto você vai precisar ter instalado na sua máquina as seguintes ferramentas:

• Git
• NodeJS
• Yarn ou NPM

Usando o template

# Gerando um repositório a partir desse template
  Clique no botão verde: "Use this template"
  Clique em "Create a new repository"
  
# Clone o repositório gerado
$ git clone [email protected]:yourUsername/yourRepository.git

# Acesse a pasta do projeto no terminal/cmd
$ cd yourRepository

# Abra essa pasta em seu editor de texto favorito
$ code .

# Instale as dependências
$ npm install
  or
$ yarn

# Execute a aplicação web em modo de desenvolvimento
$ npm run dev 
  or 
$ yarn dev

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

# Execute o storybook em modo de desenvolvimento
$ npm run storybook or yarn storybook

# O Storybook inciará na porta:6006 - acesse http://localhost:6006

Comandos úteis

• dev: Roda a aplicação em localhost:3000
• build: Cria a versão de produção
• storybook: Roda o Storybook em localhost:6006
• test: Roda os testes de todos os componentes e páginas
• test --watch: Roda os testes e continua assistindo modificações nos arquivos
• lint: Executa o linter em todos os componentes e páginas
• generate: Gera a estrutura de um novo componente

📝 Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

Feito com ♥ by José Ronaldo :wave: