https://github.com/crazyfactory/pim-aurelia-sdk
https://github.com/crazyfactory/pim-aurelia-sdk
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/crazyfactory/pim-aurelia-sdk
- Owner: crazyfactory
- License: cc0-1.0
- Created: 2016-04-08T07:31:41.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2017-02-09T05:51:53.000Z (over 9 years ago)
- Last Synced: 2025-06-04T20:23:44.455Z (about 1 year ago)
- Language: TypeScript
- Size: 241 KB
- Stars: 0
- Watchers: 11
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# pim-aurelia-sdk
This SDK offers easy access to the Crazy Factory PIM API for Aurelia based web apps.
## Installation
The SDK should be installed as an aliased JSPM Package.
```shell
jspm install pim-api=github:crazyfactory/pim-aurelia-sdk
```
## Usage
Basic example for retrieving data
```typescript
// Import an Api class
import {CurrenciesApi} from 'pim-api';
// Instantiate with default settings (you may pass a config object)
let currenciesApi = new CurrenciesApi();
// Call the API to get Data
currenciesApi.get("USD").then((res) => {
// handle result
}).fail((e) => {
// handle error
});
```
Basic example for storing data
```typescript
// Import an Api class
import {CurrenciesApi} from 'pim-api';
import {ICurrencyData} from 'pim-data';
// Create a new currency
let data: ICurrencyData = {
Key: "EUR",
Name: "Euro"
};
// Instantiate it (you may pass a config object)
let currenciesApi = new CurrenciesApi();
// Call the API to get Data
currenciesApi.create(data).then((res) => {
// handle result
}).fail((e) => {
// handle error
});
```
## Building The Code
To build the code, follow these steps.
1. Ensure that [NodeJS](http://nodejs.org/) is installed. This provides the platform on which the build tooling runs.
2. From the project folder, execute the following command:
```shell
npm install
```
3. Ensure that [Gulp](http://gulpjs.com/) is installed. If you need to install it, use the following command:
```shell
npm install -g gulp
```
4. To build the code, you can now run:
```shell
gulp build
```
5. You will find the compiled code in the `dist` folder, available in three module formats: AMD, CommonJS and ES6.
6. See `gulpfile.js` for other tasks related to generating the docs and linting.
## Running The Tests
To run the unit tests, first ensure that you have followed the steps above in order to install all dependencies and successfully build the library. Once you have done that, proceed with these additional steps:
1. Ensure that the [Karma](http://karma-runner.github.io/) CLI is installed. If you need to install it, use the following command:
```shell
npm install -g karma-cli
```
2. Ensure that [jspm](http://jspm.io/) is installed. If you need to install it, use the following commnand:
```shell
npm install -g jspm
```
3. Install the client-side dependencies with jspm:
```shell
jspm install
```
4. You can now run the tests with this command:
```shell
karma start
```