https://github.com/franciscoossian/gemkt

A email marketing generator
https://github.com/franciscoossian/gemkt

Last synced: 27 days ago
JSON representation

A email marketing generator

• Host: GitHub
• URL: https://github.com/franciscoossian/gemkt
• Owner: FranciscoOssian
• Created: 2021-08-05T17:27:44.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-08-07T01:15:43.000Z (over 3 years ago)
• Last Synced: 2024-09-14T21:20:04.810Z (about 2 months ago)
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/gemkt
• Size: 27.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Gemkt 

a email marketing generator.

type ```node . help``` to see the lite doc of the gemkt

# Project struct to run the library

```

📦teste

 ┣ 📂htmls

 ┃ ┣ 📂build

 ┃ ┃ ┗ 📜index.html

 ┃ ┣ 📜out.html

 ┃ ┗ 📜template.html

 ┣ 📂images

 ┃ ┣ 📜index_02.png

 ┃ ┣ 📜index_03.png

 ┃ ┗ 📜index_04.png

 ┣ 📜data.json

 ┣ 📜gemkt.config.js

 ┣ 📜index.js

 ┗ 📜package.json

 ```

# GEMKT function

## Parameters

  

    Name

    Type 

    Use

  

  

    help

    boolean

    To execute the help function

  

  

    cleanCache

    boolean

    To clean the cache of html data

  

  

    templateCmd

    array

    Array to define the number of images in one line

  

# GEMKT config file js (gemkt.config.js)

Gemkt configuration works with a ```gemkt.config.js``` file declareted in your project root.

## Example of gemkt.config.js file

```

const { resolve } = require('path');

config = {

  paths: {

    outFile: resolve('htmls/out.html'),

    templateFile: resolve('htmls/template.html'),

    imagesFolder: resolve('images/'),

    dataFile: resolve('data.json'),

  }

}

module.exports = config

```

# The Data file

In your projet you will declare a data.json file, with contains the images, links and alts of the email marketing.

Its a Arry with each element contains a Object with image, link and alt for construct the html file.

# The especial CleanCache prop

In Gemkt main function parameter object, exists a prop calls cleanCache. This props when ```true``` automatically clean the link, alt, image filds of data.json and populates data.json with images based on images folder