react-avancado-boilerplate

Projeto construído com base no curso de React Avançado do Willian Justen. Esse boilerplate visa facilitar a construção de novos projetos.

Para executar esse projeto é necessário ter o Node.js e NPM ou Yarn instalados em seu computador:

• Node.js
• NPM
• Yarn

Verificar os requisitos

Para verificar se você tem o Node.js instalado, execute este comando em seu terminal:

node -v

Para confirmar que o npm está instalado, você pode executar este comando no seu terminal:

npm -v
# ou
yarn -v

📌 Nota:

• Se os comandos não forem encontrados, reinicie o terminal.

• Se ainda não funcionar, verifique se o caminho onde o Node.js foi instalado, encontra-se nas variáveis de ambiente do seu sistema operacional, se não estiver, insira-o e reinicie o terminal novamente.

• Em último caso, reinstale o Node.js.

Esse projeto foi desenvolvido com as seguintes tecnologias:

• Node.js
• Next.js
• ReactJS
• TypeScript
• Styled Components
• Jest
• React Testing Library
• Storybook
• ESLint
• Prettier
• Husky
• Next PWA

Para iniciar o projeto em seu computador, primeiramente é necessário clonar esse repositório. Para isso, abra o seu terminal, navegue até a pasta onde deseja manter o projeto baixado. Após, digite o seguinte comando:

git clone https://github.com/nicolas-justin/react-avancado-boilerplate.git

Feito o download, iniciaremos o projeto. Navegue até a pasta react-avancado-boilerplate:

cd react-avancado-boilerplate

Agora iremos instalar as dependências do projeto, com o seguinte comando:

npm install
# ou
yarn

Após baixado as dependências, iremos iniciar o servidor executando:

npm start
# ou
yarn start

Pronto!

• dev: executa a aplicação no endereço localhost:3000
• build: constrói a versão da aplicação otimizada para produção
• start: inicia um servidor simples da aplicação com a versão otimizada para produção
• lint: executa o Linter em todos as páginas e componentes da aplicação
• test: utiliza o Jest para testar todos as páginas e componentes da aplicação
• test:watch: executa o Jest em "watch mode"
• storybook: executa o Storybook no endereço localhost:6006
• build-storybook: constrói a versão do Storybook otimizada para produção

Siga os passos abaixo para contribuir com a melhoria do projeto:

• Faça um fork desse repositório;
• Crie uma branch com a sua feature: git checkout -b sua-feature;
• Faça commit das suas alterações: git commit -m "Feature: Descrição da sua feature.";
• Faça push para a sua branch: git push origin sua-feature;

📌 Nota:

• Após o merge de seu pull request, não esqueça de deletar a sua branch.

Esse projeto encontra-se sob a licença MIT. Para mais detalhes, consulte o arquivo LICENSE.

---