https://github.com/labd/akeneo-node-sdk
https://github.com/labd/akeneo-node-sdk
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/labd/akeneo-node-sdk
- Owner: labd
- Created: 2023-02-27T13:18:53.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-08T11:42:20.000Z (over 2 years ago)
- Last Synced: 2025-01-31T23:04:38.946Z (over 1 year ago)
- Language: TypeScript
- Size: 972 KB
- Stars: 0
- Watchers: 6
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## @labdigital/akeneo-node-sdk@1.0.0
This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
Environment
* Node.js
* Webpack
* Browserify
Language level
* ES5 - you must have a Promises/A+ library installed
* ES6
Module system
* CommonJS
* ES6 module system
It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via `package.json`. ([Reference](http://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html))
### Building
To build and compile the typescript sources to javascript use:
```
npm install
npm run build
```
### Publishing
First build the package then run ```npm publish```
### Consuming
navigate to the folder of your consuming project and run one of the following commands.
_published:_
```
npm install @labdigital/akeneo-node-sdk@1.0.0 --save
```
_unPublished (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE --save