@fashioninsights-zalando/fcp-client

The fashion insights platform javascript sdk

Stats

StarsIssuesVersionUpdatedCreatedSize
@fashioninsights-zalando/fcp-client
3.15.24 years ago5 years agoMinified + gzip package size for @fashioninsights-zalando/fcp-client in KB

Readme

fcp-client-js

Fashion Content Platform - JavaScript SDK

Getting started

Install

with NPM

npm install --save @fashioninsights-zalando/fcp-client

with Yarn

yarn add @fashioninsights-zalando/fcp-client

Usage

Content Insights Client

import { ContentInsightsClient } from '@fashioninsights-zalando/fcp-client'
...

const client = ContentInsightsClient({ host: 'http://fcp-host/', tenantID: 'MY_FCP_TENANT_ID' })
...

Influencers Client

import { InfluencersClient } from '@fashioninsights-zalando/fcp-client'
...

const client = InfluencersClient({ host: 'http://fcp-host/', tenantID: 'MY_FCP_TENANT_ID' })
...

Fashion Store Client

import { FashionStoreSearchDataClient } from '@fashioninsights-zalando/fcp-client'
...

const client = FashionStoreSearchDataClient({ host: 'http://fcp-host/', tenantID: 'MY_FCP_TENANT_ID' })
...

Development

  1. Building
  • Run yarn to get the project's dependencies
  • Run yarn run build to produce minified version.
  1. Development mode
  • Having all the dependencies installed run yarn run dev. This command will generate an non-minified version and will run a watcher so you get the compilation on file change.
  1. Running the tests
  • Run yarn run test

Scripts

  • yarn run build - produces production version under the lib folder
  • yarn run dev - produces development version and runs a watcher
  • yarn run test - well ... it runs the tests :)

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.