cdp-js

What is cdp-js

This monorepo contains cdp sdk modules.

Repository structure

Folder and file structure of this repository is the following list.

root/
    dist/           // for internal release modules directory
    documents/      // specification documents for sdk modules
    packages/       // including monorepo packages
    tests/          // test for task scripts

How to start developping

You can use our scaffolding tool, cdp-cli, for starting development on cdp-js.

• Let you see https://github.com/sony/cdp-cli for more detail.

How to install (for internal release)

• npm

    $ npm install git+ssh://git@github.com/Sony/cdp-js.git
  

How to setup

If you want to use newest version, you can build the modules yourself as follow steps.

1. clone this repository

2. build the modules

    $ npm run setup
    $ npm run build
   

3. pick up from the dist directory.

    root/
        dist/
            cdp.js             js modules for dev.
            cdp.min.js         js modules for production.
            cdp.min.map        js map file.
            @types/
                 cdp.d.ts      d.ts file for this module.
   

4. setup bower module manualy to your project.

How to use

Please see the following documentation.

• English/英語
• Japanese/日本語

Or following site also has many description.

• https://sony.github.io/cdp-js

Release Notes

Please see the following link.

• Release Notes

License

Copyright 2016 Sony Corporation
Copyright 2017, 2018 Sony Network Communications Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.