open-index/open-npm huggingface dataset:
npm package: @grupojaque/mailer-jaque
Description: Basic node module
Author: JaqueOSS
Latest version: 1.0.0

# Mailer Jaque
  Module for sending mails from an ``ejs`` template.

[![pipeline status](https://gitlab.com/grupojaque/jaqueoss/mailer-jaque/badges/master/pipeline.svg)](https://gitlab.com/grupojaque/jaqueoss/mailer-jaque/commits/master)
[![coverage report](https://gitlab.com/grupojaque/jaqueoss/mailer-jaque/badges/master/coverage.svg)](https://gitlab.com/grupojaque/jaqueoss/mailer-jaque/commits/master)

## Setup
### Requirements

##### Modules

- [Nodemailer](https://nodemailer.com/about/): Used for sending the mail.
- [Ejs](http://ejs.co): Used for rendering the templates.

### Initialization

Install with;

``$ npm install mailer-jaque``

Import in project.

``const configObject = require('path/to/config.js');``\
``const mailer = require('mailer-jaque')(configObject);``


### Configuration

##### Configuration values



The module needs the transport information in the configuration.

| Key  | Description | Example |
| ---- | ----------- | -------- |
| transport.host  | Name of the email server to use | 'smtp.ethereal.email' |
| transport.port  | Port to connect to ``transport.host`` | 587 |
| transport.auth.user | Email user to use in he authentication | 'iq3i4rreg4tnevnq@ethereal.email' |
| transport.auth.pass | Email password to use in he authentication | 'DejVytmSpYGrn52fEM' |
| viewsDir | Relative route to the views to use (from the project root) | 'views' |
| templates.template_name.view | Name of the ``ejs`` file associated to the template ``template_name`` | 'test' |
| templates.template_name.subject | Subject to be used in the mail | 'Company name - Formal subject' |
| from | Remitent to be used in the email, this is a default and will be overwritten if this field is present in the mail options | 'David Plowie' |
| testMode | if ``true`` it will deactivate the mailing for testing purposes | ``false``

You can find a configuration example file [here](configuration.example.js)



## Usage


##### `send(options)`
Will send an email.
- *options*: Object containing the values to be used in the ``ejs`` rendering destinatary and  html code or the  name of the template to use. Optionally the Name of the remitent, and subject. Examples:
  ```javascript
  {
    to: 'user@mail.com',
    template: 'test',
    data: { // Values to be used in the ejs rendering
      user: {
        name: 'Ayrton',
      },
      secret_token: 'czxcsdhsgrwgg43twf'
    }
  }
  ```
   ```javascript
  {
    to: 'user@mail.com',
    from: 'Me',
    html: '<p> Hello there!</p>',
    subject: 'Hello'
  }
  ```

## Errors

Errors will be instances of `MailerError`, wich extends the Error class

| status     | message | description | 
| ---------- | --------| ------------| 
| `500`  | `serverError` | `Cant send mail without to` |
| `500`  | `serverError` | `Tamplate not found` |



## Contributors

- Emilio Martínez
npm package: @grupomateus/ciano
Description: O Ciano é um conjunto de componentes UI projetado para ser fácil de usar e eficiente para a equipe de tecnologia do Grupo Mateus. Ciano promete ajudar na criação de aplicativos de alta qualidade com agilidade e simplicidade. Ao utilizar o Ciano, a equipe 
Latest version: 0.0.1-rc12

# Ciano

O Ciano é um conjunto de componentes UI projetado para ser fácil de usar e eficiente para a equipe de tecnologia do Grupo Mateus. Ciano promete ajudar na criação de aplicativos de alta qualidade com agilidade e simplicidade. Ao utilizar o Ciano, a equipe poderá economizar tempo e recursos, ao mesmo tempo em que oferece uma experiência de usuário consistente e atraente.

## Comandos disponíveis

Aqui estão os comandos disponíveis para gerenciamento do projeto:

### Gerar release

- `yarn build`: Compila o projeto para produção.

### Testes

- `yarn test`: Executa testes de unidade com Jest.

### Validação e formatação de código

- `yarn stylelint`: Verifica se o estilo CSS/SCSS do projeto está de acordo com as configurações definidas no arquivo .stylelintrc.json.

- `yarn tslint`: Verifica se o TypeScript do projeto está de acordo com as configurações definidas no arquivo tslint.json.

- `yarn format`: Aplica formatação automática ao código do projeto, com base nas configurações de Prettier.

- `yarn format:check`: Verifica se o código do projeto está de acordo com as configurações de Prettier.

### Documentação

- `yarn compodoc:build`: Compila a documentação da API do projeto, utilizando Compodoc.

- `yarn compodoc:build-and-serve`: Compila e inicia o servidor da documentação da API do projeto, utilizando Compodoc.

- `yarn compodoc:serve`: Inicia o servidor da documentação da API do projeto, utilizando Compodoc.

## Quer colaborar?

Para desenvolver e testar o Ciano localmente, você precisa seguir os seguintes passos:

Acessar o diretório do ciano e rodar o comando:

Para gerar a distribuição e fazer monitoramento de modificações:

```
yarn watch
```

Em seguida, fazer link do diretório de distribuição:

```shell
cd dist/
yarn link
```

Isso irá adicionar um link direto para o Ciano que ficará disponível para uso externo via uso do comando `yarn link ciano`.

No projeto que irá utilizar o Ciano, adicione `"preserveSymlinks": true` no arquivo `angular.json`:

```json
architect": {
  "build": {
    "builder": "@angular-devkit/build-angular:browser",
    "options": {
      ...
      "preserveSymlinks": true, // <---------------------
      ...
    },
```

Em seguida, faça o link do ciano no projeto que deseja utilizar:

```shell
yarn link ciano
```

Pronto, a partir de agora a biblioteca estará disponível para uso e desenvolvimento local.

Para importar os estilos do Ciano, adicione a seguinte linha do arquivo `angular.json`

```json
"build": {
  "builder": "@angular-devkit/build-angular:browser",
  "options": {
    ...
    "styles": [
      ...
      "ciano/styles/main.scss" // <-------------------
    ],
    ...
  },
```

E pronto, o Ciano já pode ser consumido através aplicação.