https://github.com/menvia/farol-sdk-angular

Farol SDK for Angular 2+
https://github.com/menvia/farol-sdk-angular

Last synced: 2 days ago
JSON representation

Farol SDK for Angular 2+

• Host: GitHub
• URL: https://github.com/menvia/farol-sdk-angular
• Owner: menvia
• Created: 2018-12-11T12:34:16.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-02-02T18:30:37.000Z (about 1 year ago)
• Last Synced: 2024-12-16T06:15:11.403Z (about 2 months ago)
• Language: JavaScript
• Size: 166 KB
• Stars: 0
• Watchers: 5
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Farol SDK for Angular

## Install

### Using Bower

- To install or update run ```

bower install angular-farol-sdk#2.0.0 -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

```