https://github.com/getcandy/js-client
Javascript client for GetCandy v1
https://github.com/getcandy/js-client
Last synced: about 1 year ago
JSON representation
Javascript client for GetCandy v1
- Host: GitHub
- URL: https://github.com/getcandy/js-client
- Owner: getcandy
- Created: 2020-05-12T07:26:10.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-07-21T13:05:30.000Z (almost 5 years ago)
- Last Synced: 2025-02-15T11:27:39.486Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 1.74 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## @getcandy/js-client@0.12.1
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). 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 @getcandy/js-client@0.12.1 --save
```
_unPublished (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE --save