https://github.com/menvia/farol-extension-fs-aws

Farol Extension - AWS S3
https://github.com/menvia/farol-extension-fs-aws

Last synced: 2 days ago
JSON representation

Farol Extension - AWS S3

• Host: GitHub
• URL: https://github.com/menvia/farol-extension-fs-aws
• Owner: menvia
• Created: 2019-03-19T20:38:05.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-09-15T02:41:02.000Z (over 1 year ago)
• Last Synced: 2025-01-17T19:49:26.536Z (24 days ago)
• Language: JavaScript
• Size: 19.5 KB
• Stars: 0
• Watchers: 6
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.MD
  • Changelog: CHANGELOG.MD

Awesome Lists containing this project

README

        
# Farol Extension for Lahar

## Install

### Using NPM

- To install, run:

  `npm install farol-extension-fs-aws`

- To update, run:

  `npm update farol-extension-fs-aws`

## Develop

### NPM

Use `npm link` in the API project repository inside the extensions folder in order to store the link name and path in NPM.

On the project used to develop the library you can run `npm link farol-extension-fs-aws` and it will start using the development version from your API.

## Publish

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

1. Make the desired changes;

2. Update CHANGELOG.md file;

3. Commit your changes;

4. 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

```