https://github.com/etiennemarais/team-press-release

A small lib to automate sending weekly catchup emails to the team
https://github.com/etiennemarais/team-press-release

Last synced: about 5 hours ago
JSON representation

A small lib to automate sending weekly catchup emails to the team

• Host: GitHub
• URL: https://github.com/etiennemarais/team-press-release
• Owner: etiennemarais
• License: mit
• Created: 2017-10-31T15:58:01.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-24T23:31:57.000Z (almost 2 years ago)
• Last Synced: 2023-12-17T03:41:57.468Z (11 months ago)
• Language: JavaScript
• Size: 231 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# team-press-release

A small lib to automate sending weekly catchup emails to the team

## Getting started

#### 1. Clone the repo to your pc or run:

```

git clone https://github.com/etiennemarais/team-press-release.git

```

#### 2. Make sure you have `yarn` installed then run it inside of the directory:

```

yarn install

```

#### 3. To send a mail you can edit the `-weekly-catchup.mjml` file in the project root. Icons are a treat. I upload free to use icons to an open github issue so I can use that url in my email template since inlining of images does not work. I use this repo (https://icons8.com/icon/new-icons)

#### 4. VSCode has a nice [plugin](https://github.com/attilabuti/vscode-mjml), (https://marketplace.visualstudio.com/items?itemName=attilabuti.vscode-mjml) to view the template result as you type it. 

#### 5. Set Sendgrid env file

In your project root you need to set the .env file for the `SENDGRID_API_KEY`

#### 6. Run

```bash

# Test send a mail to yourself Available options

yarn test "Some Subject here"

# Send to team but using your own template, this will add all the config recipients

yarn send "Some Subject here"

# Render the template only as an html file

yarn render

```

### Icons

Icon pack by Icons8 You should check them out, it's a great resource.