BJL Yeoman Generator

This Yeoman Generator has been built to help scafold out a new email project for your chosen client. It contains index templates, grunt files, images and some font files depending on clients using web fonts. The idea behind this yeoman generator is to keep continuity between devlopers and projects, as it contains standard templates for each client thease should be used when starting any email project.

Table of Contents

• Installation
• Wendy
  • Mac Users
  • Windows Users
• Running Bjl Email Generator
• Grunt Tasks
• Getting to know Yeoman

Installation

Wendy

This email generator also makes use of another BJL Dev tool WENDY. Wendy can be installed as a stand-alone program. WENDY can be found here http://gitlab.bjl.co.uk/development/wendy-cli. Follow the instruction for installing wendy. If your installing Wendy as part of this program you may follow the instructions below for your set up (Mac / Windows)

Mac Users

Firstly you need to install brew or Homebrew as its better know (If you have brew installed you may skip this part). In terminal cd to /usr/local then exicute the following command. bash mkdir homebrew && curl -L https://github.com/Homebrew/brew/tarball/master | tar xz --strip 1 -C homebrew Once brew is installed you can now install python 3.x enter the following command. (If you have the latest version of python installed skip this part) bash brew install python Now the latest version of python is installed you can install WENDY run the following command bash pip3 install git+http://gitlab.bjl.co.uk/development/wendy-cli.git Now WENDY is installed you free to install Yeoman and Yeo-email Generator.

First, install Yeoman (You will need to have node.js installed on your machine). If you dont please install it now node.js. Then to install Yeoman run the following in terminal. bash npm install -g yo Once or if Yeoman is installed git clone this repo to an apropriate place on your machine. bash ssh [email protected]:development/generator-email.git Now cd in to the folder you just pulled from git and run the following command. bash npm link

This command will link the new generator to Yeoman And that's it All installed.

Windows users

Install git for windows.

• To install git on windows you will need git bash head over to Git-scm and download the conrisponding program ie 32 or 64 bit. Once downloaded go ahead and install it. Make sure to include Git Bash when selecting components. Continue the install keeping all settings standard. Once done click finish.

Install Python for windows

• Head over to the python website to download the latest version of python 3. Once downloaded open the exacutable choose install now option.

Install node.js for windows

• Head over to node.js and download the version that is Recommended for most users. The download may have started automaticaly, once downloded open the exe and use all standard settings.
• You will need to restart windows at this point (Sorry should have a Mac).

Install Wendy

• Go ahead and open git bash as an admin, in the terminal like window do the following command. pip3 install git+http://gitlab.bjl.co.uk/development/wendy-cli.git
• If the install faills try downloading an older version of python 3.

Install Yeoman

• In Git bash still run the following command. npm install -g yo
  • Next you will need to down load the Bjl Yeoman Generator
    • In git bash do the following command git clone [email protected]:development/generator-email.git
• Once you have cloned the repo cd in to it and run command npm link

Running Bjl Email Generator

To begin scafolding a project with the Email Generator make or move in to a dir you wish your project to reside once your there run yo email

The first screen you will be presented with will be the welcome screen as shown below

Here you are asked to choose your client each client will have a diffrent verity of questions which are required to build but diffrent folder structures. Once you have run through all the questions the generator will

• Create all files and folders needed
• Create a repo for you on Git Lab (SSH Keeys insalled reqired)
• Install dependances (Used by such programs as grunt or gulp)

Example

graph LR
A[cmd = yo email] --> B(Option - New Project)
A --> C(Option - Add to an exsisting project)
B --> D(Follow Promp's)
C --> D
D --> E{Project Created}

Grunt Tasks

Currently (08/01/2019) We are only using grunt for one client and that is coop you have the following options

• grunt pack
  • This will compress all images replace image paths and create a zip folder containg the build and images
• grunt testSend
  • This command will push the latest saved version of your build to git, it will then deploy via capasrano and then give you a list of users to send a test to use the up or down arrow to navigate the users and the space bar to select. Then you will be requested to enter a subject line. This will then send test email's to the user of your choice.

Getting To Know Yeoman

• Yeoman has a heart of gold.
• Yeoman is a person with feelings and opinions, but is very easy to work with.
• Yeoman can be too opinionated at times but is easily convinced not to be.
• Feel free to learn more about Yeoman.

Change Log

• V 3.0.01
• Split each client out in to there own Sub Genirator.
• V 4.0.0
  • Major Updates all clients working without Error
  • added new options of adding files to exsisting builds
• V 4.0.1
  • Fixed bugs with grunt files not replacing personlisation on Co-op templates
  • Updated Co-op templates to adhear to Accessablility guid lines
  • Updated Read Me
• V 4.0.2
  • Bug fix on asda client thinking is Whitespace
  • Updated Read Me
• V 4.0.3
  • Updates have been made to Asda And Co-op templates

License

GPL-3.1 © Phil dawson Build Version 4.0.3