olist-marketing-actions

This project must contain all activities related at marketing actions and handle it for web

Installing / Getting started

  yarn add @olist/marketing-actions

It has microbundle as peer dependencie. So, be careful whether some warning about version compatibility pops up or not after the installation.

Developing

Built With

It was built on ES6.

Prerequisites

Node version >= 8.9.0 <12.0.0.
Npm version >= 5.5.1.
It's fairly recommended using yarn for packages management.

Setting up Dev

Ok, you're looking forward to contributing for the olist-marketing-actions, then follow the instructions.

If you're here, you already have access to the repository, haven't you? So, just clone the project and install the dependencies.

git clone git@github.com:olist/olist-marketing-actions.git
cd olist-marketing-actions/
yarn

If it's everything okay on your environment all olist-marketing-actions dependencies were installed, but if something went wrong feel free to create an issue reporting the problem.

Building

  yarn build

This generate a bundle, including a umd files for all files imported at index.js

TODO

[ ] Tests
[ ] Lint
[ ] Publishing