Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/andhikamaheva/mailchimp-nodejs

Unofficial Node.js Client Library for MailChimp API http://developer.mailchimp.com
https://github.com/andhikamaheva/mailchimp-nodejs

expressjs mailchimp mailchimp-api mandrill mandrill-api nodejs

Last synced: about 1 month ago
JSON representation

Unofficial Node.js Client Library for MailChimp API http://developer.mailchimp.com

Awesome Lists containing this project

README

        

# MailChimp NodeJS (Under Development)

[![NPM Version][npm-image]][npm-url]
[![NPM Downloads][downloads-image]][downloads-url]
[![Linux Build][build-image]][build-url]
[![Windows Build][appveyor-image]][appveyor-url]
[![Coverage Status][coveralls-image]][coveralls-url]

MailChimp NodeJS is NodeJS Package allows you to quickly and easily use the MailChimp API v3 via Node.js.
Please browse the rest of this README for further detail.

We appreciate your continued support, thank you!

# Table of Contents

* [Installation](#installation)
* [Quick Start](#quick_start)
* [Usage](#usage)
* [Use Cases](#use_cases)
* [Announcements](#announcements)
* [Roadmap](#roadmap)
* [How to Contribute](#contribute)
* [Troubleshooting](#troubleshooting)
* [About](#about)
* [License](#license)


# Installation

## Prerequisites
- Node.js version 4, 6 or 7
- The MailChimp service, ready to use (Verified account & has API Key)

## Install Package

The following recommended installation requires [npm](https://npmjs.org/). If you are unfamiliar with npm, see the [npm docs](https://npmjs.org/doc/). Npm comes installed with Node.js since node version 0.8.x therefore you likely already have it.

```bash
npm install --save mailchimp-nodejs
```

## Dependencies
There are some dependencies support this package :

### Main Dependencies
* [fs](https://nodejs.org/api/fs.html)
* [http](https://www.npmjs.com/package/http)
* [request](https://github.com/request/request)

### Development Dependencies
* [assert](https://github.com/defunctzombie/commonjs-assert)
* [chai](https://github.com/chaijs/chai)
* [coveralls](https://github.com/nickmerwin/node-coveralls)
* [istanbul](https://github.com/gotwarlost/istanbul)
* [mocha](https://github.com/mochajs/mocha)
* [mocha-lcov-reporter](https://github.com/StevenLooman/mocha-lcov-reporter)
* [nock](https://github.com/node-nock/nock)
* [vows](https://github.com/vowsjs/vows)


# Quick Start


# Usage


# Use Cases


# Announcements


# Roadmap


# How to Contribute


# Troubleshooting


# About


# License

**MIT License**

Copyright (c) 2017 Andhika Maheva Wicaksono

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

[build-image]: https://img.shields.io/travis/andhikamaheva/mailchimp-nodejs/master.svg?label=linux
[build-url]: https://travis-ci.org/andhikamaheva/mailchimp-nodejs
[npm-image]: https://badge.fury.io/js/mailchimp-nodejs.svg
[npm-url]: https://badge.fury.io/js/mailchimp-nodejs
[downloads-image]: https://img.shields.io/npm/dm/mailchimp-nodejs.svg
[downloads-url]: https://npmjs.org/package/mailchimp-nodejs
[appveyor-image]: https://img.shields.io/appveyor/ci/andhikamaheva/mailchimp-nodejs/master.svg?label=windows
[appveyor-url]: https://ci.appveyor.com/project/andhikamaheva/mailchimp-nodejs
[coveralls-image]: https://coveralls.io/repos/github/andhikamaheva/mailchimp-nodejs/badge.svg?branch=master
[coveralls-url]: https://coveralls.io/github/andhikamaheva/mailchimp-nodejs?branch=master