# @indream/skygear-core > Core of Skygear JS SDK Latest version **1.4.0-custom0** (published 2018-03-20) · Apache-2.0 license · 0 weekly downloads ## Install ```sh npm install @indream/skygear-core pnpm add @indream/skygear-core yarn add @indream/skygear-core bun add @indream/skygear-core ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.4.0-custom0 | | Published | 2018-03-20 | | First published | 2018-03-06 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 18 | | Unpacked size | 2.6 MB | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 23 | | Author | rickmak | | Maintainers | indream | | Keywords | SDK, skygear | ## Links - npm: https://www.npmjs.com/package/@indream/skygear-core - Repository: https://github.com/SkygearIO/skygear-SDK-JS - Issues: https://github.com/SkygearIO/skygear-SDK-JS/issues - npm.io page: https://npm.io/package/@indream/skygear-core ## Dependencies (18) - [pg](https://npm.io/package/pg.md) ^6.1.0 - [md5](https://npm.io/package/md5.md) ^2.0.0 - [ncp](https://npm.io/package/ncp.md) ^2.0.0 - [url](https://npm.io/package/url.md) ^0.11.0 - [uuid](https://npm.io/package/uuid.md) ^2.0.1 - [Base64](https://npm.io/package/Base64.md) ^0.3.0 - [dotenv](https://npm.io/package/dotenv.md) ^4.0.0 - [lodash](https://npm.io/package/lodash.md) ^4.17.4 - [w3c-blob](https://npm.io/package/w3c-blob.md) 0.0.1 - [websocket](https://npm.io/package/websocket.md) ^1.0.23 - [formidable](https://npm.io/package/formidable.md) ^1.0.17 - [mime-types](https://npm.io/package/mime-types.md) ^2.1.12 - [superagent](https://npm.io/package/superagent.md) ^3.4 - [event-emitter](https://npm.io/package/event-emitter.md) ^0.3.4 - [babel-polyfill](https://npm.io/package/babel-polyfill.md) ^6.13.0 - [cookie-storage](https://npm.io/package/cookie-storage.md) ^1.0.4 - [localstorage-memory](https://npm.io/package/localstorage-memory.md) ^1.0.2 - [amazon-s3-url-signer](https://npm.io/package/amazon-s3-url-signer.md) ^0.1.0 ## Recent versions - 1.4.0-custom0 (latest) — 2018-03-20 - 1.4.0 — 2018-03-20 - 1.3.1 — 2018-03-06 ## README # Skygear SDK for JavaScript [![@skygear/web](https://img.shields.io/npm/v/@skygear/web.svg?label=@skygear/web)](https://www.npmjs.com/package/@skygear/web) [![@skygear/web](https://img.shields.io/npm/dt/@skygear/web.svg?label=@skygear/web)](https://www.npmjs.com/package/@skygear/web) [![@skygear/node-client](https://img.shields.io/npm/v/@skygear/node-client.svg?label=@skygear/node-client)](https://www.npmjs.com/package/@skygear/node-client) [![@skygear/node-client](https://img.shields.io/npm/dt/@skygear/node-client.svg?label=@skygear/node-client)](https://www.npmjs.com/package/@skygear/node-client) [![@skygear/react-native](https://img.shields.io/npm/v/@skygear/react-native.svg?label=@skygear/react-native)](https://www.npmjs.com/package/@skygear/react-native) [![@skygear/react-native](https://img.shields.io/npm/dt/@skygear/react-native.svg?label=@skygear/react-native)](https://www.npmjs.com/package/@skygear/react-native) [![Build Status](https://travis-ci.org/SkygearIO/skygear-SDK-JS.svg?branch=next)](https://travis-ci.org/SkygearIO/skygear-SDK-JS) ![License](https://img.shields.io/badge/license-Apache%202-blue) ## Documentation View the API Reference at [https://skygeario.github.io/skygear-SDK-JS/](https://skygeario.github.io/skygear-SDK-JS/). ## Usage ### Web ```sh $ npm install --save @skygear/web ``` ### Node ```sh $ npm install --save @skygear/node-client ``` ### React Native ```sh $ npm install --save @skygear/react-native ``` ### Script Tag [https://unpkg.com/@skygear/web@latest/dist/skygear-web.iife.js](https://unpkg.com/@skygear/web@latest/dist/skygear-web.iife.js) Replace `latest` with the version you want to use. ## Running the example The example assumes a local DNS server that is able to resolve `.localhost`. On macOS, you can install `dnsmasq`. ```sh $ git clone --branch next https://github.com/SkygearIO/skygear-SDK-JS.git $ cd skygear-SDK-JS $ npm install $ npm run lerna bootstrap $ npm run build $ npm run example ``` ## Running example with custom gears endpoint ``` $ SKYGEAR_APP_ENDPOINT= \ $ SKYGEAR_AUTH_ENDPOINT= \ $ SKYGEAR_ASSET_ENDPOINT= \ $ SKYGEAR_CLIENT_ID= \ $ npm run example ``` ## Contributing First, fork the repository. ```sh $ git clone --branch next git@github.com:/skygear-SDK-JS.git $ cd skygear-SDK-JS $ npm install $ npm run lerna bootstrap ``` ## Releasing First, ensure `github-release` and `yarn` tool is installed. Also, Git should be configured to be able to sign using GPG keys, and npm should be logged in as appropriate user. ```sh $ npm run prepare-new-release # Edit the file new-release. # It will be prepended to CHANGELOG.md # So make sure the style is consistent. $ vim new-release $ GIT_USER= GITHUB_TOKEN= GIT_BRANCH=master SKYGEAR_VERSION= ./scripts/release.sh ``` --- _Source: https://npm.io/package/@indream/skygear-core · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._