https://github.com/cloud-elements/angular-cloud-elements
AngularJS Services for interacting with Cloud Elements Platform APIs
https://github.com/cloud-elements/angular-cloud-elements
Last synced: 7 days ago
JSON representation
AngularJS Services for interacting with Cloud Elements Platform APIs
- Host: GitHub
- URL: https://github.com/cloud-elements/angular-cloud-elements
- Owner: cloud-elements
- License: mit
- Created: 2016-01-18T16:00:19.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2016-02-29T17:04:47.000Z (almost 10 years ago)
- Last Synced: 2025-08-09T01:29:18.390Z (6 months ago)
- Language: JavaScript
- Homepage:
- Size: 58.6 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# angular-cloud-elements
An AngularJS Library for interacting with the Cloud Elements Platform APIs
[](https://badge.fury.io/js/angular-cloud-elements) [](https://circleci.com/gh/cloud-elements/angular-cloud-elements) [](https://coveralls.io/github/cloud-elements/angular-cloud-elements?branch=master)
## Features
- `ceElements` for interacting with Elements and Element Instances APIs
- `ceFormulas` for interacting with Formulas and Formula Instance APIs
- `ceTransformations` for interacting with the Transformations APIs
- `ceBulk` for interacting with the Bulk APIs
## Build
```bash
npm install
npm install -g gulp
npm install -g bower
bower install
gulp build
```
__PROTIP__: `gulp build` creates two distribution files in the `/dist` folder, one concatenated and one minified
## Testing
Tests are run using Karma, mochajs and chai.js
To test files in the `/src` directory:
```bash
gulp test-src
```
To run all tests (runs against `src` and `dist`):
```bash
gulp test
```
## Installation for an Angular project
```bash
npm install angular-cloud-elements --save
```
## Usage
Include the source file available in the `/dist` folder
```html
```
A minified version is also provided
```html
```
Then, in your module include `angularCloudElements`:
```javascript
angular.module('myApp', ['angularCloudElements']);
```
Lastly, set the configs using the `ceAuth` service:
```javascript
angular.module('myApp')
.controller('myController', ['ceAuth', function(ceAuth) {
function onLogin() {
// obtain secrets
ceAuth.setConfig({
userSecret: 'a valid user secret',
orgSecret: 'a valid org secret',
baseUrl: 'base url of environment you are using'
});
}
}])
```