carvalholeo/generator-dh

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# Express Generator DH

<div style="display: flex; justify-content: center; align-items: center;">
    <img src="https://i.cloudup.com/zfY6lL7eFa-3000x3000.png" width="50%" height="auto" alt="Logo do Framework Express"/>
    <p style="display: inline-block; padding: 10px; font-size: 1.5rem;">+</p>
    <img src="https://www.digitalhouse.com/ar/logo-DH.png" width="50%" alt="Logo da Digital House" style="background-color: #fff"/>
</div>

Gerador de aplicações [Express](https://www.npmjs.com/package/express), focado nas necessidades dos alunos da [Digital House](https://www.digitalhouse.com/br).

[![NPM Version][npm-image]][npm-url]
[![NPM Downloads][downloads-image]][downloads-url]
[![Linux Build][gh-workflow-image]][gh-workflow-url]
[![Windows Build][gh-windows-workflow-image]][gh-windows-workflow-url]
[![CodeQL][codeql-image]][codeql-url]
[![Coverage Status][coverage-image]][coverage-url]
[![Maintainability][maintainability-image]][maintainability-url]
![Vulnerabilities][vulnerabilities-image]

## Início Rápido

O caminho mais rápido para começar um projeto express é usar o executável `express-generator-dh`, para gerar uma aplicação, como o exemplo abaixo:

Criar o app:

```bash
$ npx express-generator-dh --view ejs meuProjeto
// Isto irá criar uma pasta, chamada 'meuProjeto', com suporte à EJS
```

Entrar na pasta deste projeto:

```bash
$ cd meuProjeto
// Isto faz o terminal entrar na pasta criada
```

Instalar as dependências:

```bash
$ npm install
// Faz a instalação das dependências do Express e outros pacotes
```

Iniciar seu app Express.js, no endereço `http://localhost:3000/`:

```bash
$ npm start
// Inicia o servidor para os primeiros testes
```

## Opções da Linha de Comando

Este gerador também pode ser configurado com as seguintes opções da linha de comando.

        --version        exibe a versão do gerador
    -i, --integrador     adiciona os pacotes usados no projeto integrador
    -v, --view <engine>  adiciona suporte à engine <engine> (dust|ejs|hbs|hjs|jade|pug|twig|vash) (o padrão é PUG)
        --no-view        usa HTML estático ao invés de template engine
    -c, --css <engine>   adiciona suporte à engine CSS <engine> (less|stylus|compass|sass) (o padrão é CSS puro, texto plano)
        --git            adiciona .gitignore
        --dotenv         adiciona o pacote dotenv, para trabalhar com variáveis de ambiente. Chama automaticamente --git
    -s, --silent         executa instalação silenciosa (entra no diretório, instala as dependências e faz o primeiro commit)
    -a, --api            usar um template de web api sem uma view engine
    -f, --force          força a criação em diretórios não-vazios
    -h, --help           exibe informações de uso e ajuda

## Licença

[MIT](LICENSE)

[npm-image]: https://img.shields.io/npm/v/express-generator-dh.svg
[npm-url]: https://npmjs.org/package/express-generator-dh
[gh-workflow-image]: https://github.com/carvalholeo/generator-dh/actions/workflows/npm-publish.yml/badge.svg?branch=main
[gh-workflow-url]: https://github.com/carvalholeo/generator-dh/actions/workflows/npm-publish.yml
[gh-windows-workflow-image]: https://github.com/carvalholeo/generator-dh/actions/workflows/windows-test.yml/badge.svg
[gh-windows-workflow-url]: https://github.com/carvalholeo/generator-dh/actions/workflows/windows-test.yml
[downloads-image]: https://img.shields.io/npm/dm/express-generator-dh
[downloads-url]: https://www.npmjs.com/package/express-generator-dh
[codeql-image]: https://github.com/carvalholeo/generator-dh/actions/workflows/codeql-analysis.yml/badge.svg?branch=main
[codeql-url]: https://github.com/carvalholeo/generator-dh/actions/workflows/codeql-analysis.yml
[coverage-image]: https://coveralls.io/repos/github/carvalholeo/generator-dh/badge.svg?branch=main
[coverage-url]: https://coveralls.io/github/carvalholeo/generator-dh?branch=main
[maintainability-image]: https://api.codeclimate.com/v1/badges/546438504d4f8ab29922/maintainability
[maintainability-url]: https://codeclimate.com/github/carvalholeo/generator-dh/maintainability
[vulnerabilities-image]: https://img.shields.io/snyk/vulnerabilities/npm/express-generator-dh