https://github.com/mono-js/mono-drive

Mono module to manage storage (fileSystem, S3)
https://github.com/mono-js/mono-drive

Last synced: 4 months ago
JSON representation

Mono module to manage storage (fileSystem, S3)

• Host: GitHub
• URL: https://github.com/mono-js/mono-drive
• Owner: mono-js
• License: mit
• Created: 2018-03-11T21:56:49.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-08-20T23:10:50.000Z (almost 7 years ago)
• Last Synced: 2025-02-05T19:03:52.335Z (5 months ago)
• Language: JavaScript
• Size: 113 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mono-drive

Mono module to manage storage (fileSystem, S3)

[![npm version](https://img.shields.io/npm/v/mono-drive.svg)](https://www.npmjs.com/package/mono-drive)

[![Travis](https://img.shields.io/travis/gaetansenn/mono-drive/master.svg)](https://travis-ci.org/gaetansenn/mono-drive)

[![Coverage](https://img.shields.io/codecov/c/github/gaetansenn/mono-drive/master.svg)](https://codecov.io/gh/gaetansenn/mono-drive)

[![license](https://img.shields.io/github/license/gaetansenn/mono-drive.svg)](https://github.com/gaetansenn/mono-drive/blob/master/LICENSE)

## Installation

```bash

npm install --save mono-drive

```

Then, in your configuration file of your Mono application (example: `conf/application.js`):

```js

module.exports = {

  mono: {

    modules: ['mono-drive']

  }

}

```

## Configuration

`mono-drive` will use the `mono.drive` property of your configuration (example: `conf/development.js`):

```js

module.exports = {

  mono: {

    drive: {

      fs: {

        root: '' //path of the root directory

      },

      s3: {

        key: // Access key id `accessKeyId`

        secret: // secret access key `secretAccessKey`

        region: // region

      }

    }

  }

}

```

## Usage

In your `src/` files of your Mono project, you can access exposed methods like this:

```js

const { get, put, del } = require('mono-drive')

```

## Development / Contribution

See the [contribution guidelines](CONTRIBUTING.md) of this project.

## License

MIT © gaetansenn