Open Dictionary Emails

Email templates used in Open Dictionary.

Open Dictionary consists of a set of services that you use to serve dictionary entries in an open source manner. This project is heavily inspired by PokeAPI. PokeAPI is a service that provides a handful of data regarding Pokémon games. You can read more at their official website.

Getting Started

First off some requirements:

• node & npm, required (link)
• yarn, highly recommended (link)
• Visual Studio Code, highly recommended (link)
• git, required if you want to contribute (link)
• 'something to unzip zips', optional

Now that everything you need is clear enough, let's proceed on the setup...

Get the project

You have two options:

1. Using git, clone the repository in you local machine:

   git clone https://github.com/niktekusho/open-dictionary-emails

2. Downloading the source code from GitHub using the releases page.

Dependencies

If you have yarn installed:

yarn install

otherwise using npm:

npm install

Build the template

This command will build the ejs templates, sass stylesheets and the rest and bundle them together into an html file.

If you have yarn installed:

yarn build

otherwise using npm:

npm run build

Preview the template

This command will open a browser window/tab pointing to a development server running on you local machine.

If you have yarn installed:

yarn watch

otherwise using npm:

npm run watch

Delete the generated files

If you have yarn installed:

yarn clean

otherwise using npm:

npm run clean

Repository Structure

open-dictionary-emails
|_ src (source code)
  |_ css (compiled from .scss or manually added)
  |_ emails (.ejs files)
  |_ images (all images)
  |_ sass (.scss files)
  |_ testing (.json files)
|_  .editorconfig
|_  LICENSE
|_  README.md (this document 👀)
|_  detect-json.js
|_  gulpfile.js
|_  package.json
|_  yarn.lock