zeplin-client

Zeplin NodeJS Client with OAuth

Usage no npm install needed!

<script type="module">
  import zeplinClient from 'https://cdn.skypack.dev/zeplin-client';
</script>

README

Zeplin OAuth NodeJs API Client

greenkeeper: enabled build: status codecov: percent commitizen: friendly code style: prettier semantic-release linter: eslint docs: gh-pages npm (scoped)

Prerequisites

You will require the following to make use of this boilerplate.

  1. Github account.
  2. Node.js installed on your local machine and optionally yarn.
  3. Git installed on your local machine.
  4. An IDE with javascript/typescript support.

Recommended IDE

You should be using Visual Studio Code because its simple, fast, extensible and beloved by many developers.

Make sure to install all the recommended extensions that come with the repository for the best possible coding experience.

Quick Start

Install package using npm i --save zeplin-client

import Client, { Types } from 'zeplin-client'

const client = new Client('app-id', 'app-secret', 'https://api.relevantfruit.com')

const pagination: Types.Pagination = { limit: 100, offset: 0 }
client
  .getScreens('my-access-token', pagination)
  .then(console.log)
  .catch(console.error)