# angular-farol-sdk

> Farol SDK for AngularJS

Latest version **1.2.3** (published 2019-03-24) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install angular-farol-sdk
pnpm add angular-farol-sdk
yarn add angular-farol-sdk
bun add angular-farol-sdk
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.3 |
| Published | 2019-03-24 |
| First published | 2018-06-25 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 6.0.0 |
| Dependencies | 2 |
| Unpacked size | 7.2 KB |
| Known vulnerabilities | 0 (+10 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Felipe Plets |
| Maintainers | capetry, delon.borges, devmenvia, felipeplets |
| Keywords | farol |

## Links

- npm: https://www.npmjs.com/package/angular-farol-sdk
- Repository: https://github.com/menvia/farol-sdk-angularjs
- Homepage: https://github.com/menvia/farol-sdk-angularjs#readme
- Issues: https://github.com/menvia/farol-sdk-angularjs/issues
- npm.io page: https://npm.io/package/angular-farol-sdk

## Dependencies (2)

- [angular](https://npm.io/package/angular.md) ^1.7.8
- [farol-sdk](https://npm.io/package/farol-sdk.md) ^1.15.0

## Recent versions

- 1.2.3 (latest) — 2019-03-24
- 1.2.2 — 2019-02-19
- 1.2.1 — 2019-02-19
- 1.2.0 — 2019-02-19
- 1.1.7 — 2018-11-18
- 1.1.6 — 2018-09-27
- 1.1.5 — 2018-08-28
- 1.1.4 — 2018-08-08
- 1.1.2 — 2018-08-06
- 1.1.1 — 2018-07-24
- 1.1.0 — 2018-07-24
- 1.0.11 — 2018-07-04
- 1.0.10 — 2018-07-02
- 1.0.9 — 2018-06-28
- 1.0.8 — 2018-06-27
- … 8 more at https://npm.io/package/angular-farol-sdk/versions

## README

# Farol SDK for AngularJS

## Install
### Using Bower

- To install or update run ```
bower install angular-farol-sdk#1.2.3 -S -F
```

### Using NPM

- To install run ```
npm install angular-farol-sdk
```
- To update run ```
npm update angular-farol-sdk
```

## Develop
In order to develop the Farol Angular SDK for JavaScript we recommend that you first read the subsection based on the package manager you are using:

In order to debug use ```gulp debug``` task. Read more bellow in *building* section.

### Bower
Use ```bower link``` in the SDK project repository in order to store the link name and path in Bower.

On the project used to develop the library you can run ```bower link angular-farol-sdk``` and it will start using the development version from your SDK.

If you decide to rollback to the production version of the library you shall remember to run ```bower unlink angular-farol-sdk``` and run the installation step again.

### NPM
Use ```npm link``` in the SDK project repository in order to store the link name and path in NPM.

On the project used to develop the library you can run ```npm link angular-farol-sdk``` and it will start using the development version from your SDK.

## Build

We use gulp in order to build the Farol SDK for JavaScript. There are two different tasks that you can call from your terminal:
- ```gulp``` will build the production version
- ```gulp debug``` will build the debug version but will not uglify the code

## Publish

In order to release a new version you shall follow the steps bellow:

1. Make the desired changes;
2. If new files were added, update gulpfile.js file;
3. Update CHANGELOG.md file;
4. Commit your changes;
5. Run the commands below:
- Run ```
npm version patch
FAROL_SDK_VERSION=$(npx -c 'echo "$npm_package_version"')
git commit -am"${FAROL_SDK_VERSION}"
git tag ${FAROL_SDK_VERSION}
git push && git push --tags
```

---
_Source: https://npm.io/package/angular-farol-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._