Qualicode Boilerplate JS

Conjunto de ferramentas reunidas e já configuradas para a produção de código JavaScript com alta qualidade.

Getting Started

Essas instruções irão ajudá-lo a começar ultilizar o Qualicode Boilerplate JS para desenvolver projetos JavaScript.

Pré-requisitos

Você deverá instalar previamente:

Node.js - A JavaScript runtime built on Chrome's V8 JavaScript engine.
npm - The package manager for JavaScript and the world’s largest software registry. Discover packages of reusable code — and assemble them in powerful new ways.
Git - A free and open source distributed version control system designed to handle everything from small to very large projects with speed and efficiency.

Fazendo a instalação

É necessário clonar o repositório:

git clone https://github.com/jamesodas/qualicode-bp-js.git meu-projeto

Entrar no diretório do projeto:

cd meu-projeto

E executar o comando:

npm run newdev

Pronto! Agora você já pode começar a desenvolver seu código, garantindo alta qualidade.

Executando os testes

Executar um teste:

npm run test

Ativar testes automáticos:

npm run test:tdd

Verificar a cobertura dos testes:

npm run test:coverage

Verificando estilo de codificação

Você pode verificar o estilo de codificação com o comando:

npm run lint

Hooks do Git

Os comandos git commit e git push só são aceitos se todos os testes até então definidos passarem e se os códigos desenvolvidos estiverem seguindo o guia de estilo da AirBnb.

Fazendo Build

Para fazer o build do produto, deve utilizar o comando:

npm run build

Modo escuta:

npm run build:watch

Versão para produção (arquivo minificado):

npm run build:prod

Ferramentas utilizadas

Webpack - A static module bundler for modern JavaScript applications.
Babel - The compiler for writing next generation JavaScript.
Mocha - The fun, simple, flexible JavaScript test framework.
Chai - A BDD / TDD assertion library for node and the browser that can be delightfully paired with any javascript testing framework.
Nyc - The Istanbul command line interface.
ESLint - Pluggable JavaScript linter.
Husky - Git hooks made easy.

Autores

James Oliveira da Silva - Initial work - jamesodas

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

jamesdasilva/qualicodejs