UNPKG

2.37 kBMarkdownView Raw
1# contentful-sdk-core
2
3![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)
4[![NPM Version](https://img.shields.io/npm/v/contentful-sdk-core.svg)](https://www.npmjs.com/package/contentful-sdk-core)
5[![npm downloads](https://img.shields.io/npm/dm/contentful-management.svg)](http://npm-stat.com/charts.html?package=contentful-management)
6[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)
7[![semantic-release](https://img.shields.io/badge/%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
8[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
9
10> This package contains some core modules and utilities used by both the [contentful.js](https://github.com/contentful/contentful.js) and [contentful-management.js](https://github.com/contentful/contentful-management.js) SDKs.
11
12## About
13
14[Contentful](https://www.contentful.com) provides a content infrastructure for digital teams to power content in websites, apps, and devices. Unlike a CMS, Contentful was built to integrate with the modern software stack. It offers a central hub for structured content, powerful management and delivery APIs, and a customizable web app that enable developers and content creators to ship digital products faster.
15
16## Installation
17
18```
19npm install --saveDev contentful-sdk-core
20```
21
22## Use case
23
24This package contains some core modules and utilities used by both the [contentful.js](https://github.com/contentful/contentful.js) and [contentful-management.js](https://github.com/contentful/contentful-management.js) SDKs.
25
26## Support
27
28This repository is compatible with Node.js version 18 and later. It exclusively provides an ECMAScript Module (ESM) variant, utilizing the `"type": "module"` declaration in `package.json`. Users are responsible for addressing any compatibility issues between ESM and CommonJS (CJS).
29
30## Types
31
32TypeScript definitions for this repository are available through the `"types"` property in `package.json`.
33
34## Development
35
36### Create the default and the es-modules build:
37
38```
39npm run build
40```
41
42### Run Tests:
43
44Run only the unit tests:
45
46```
47npm run test
48```
49
50Run unit tests including coverage report:
51
52```
53npm run test:cover
54```
\No newline at end of file