Skip to content

Getting Started

To get started with @open-nebel/nest-s3, follow the installation and configuration steps outlined in this documentation. Whether you are storing and retrieving simple files or building complex data workflows, this library provides the tools and flexibility you need.

Installation

Install the package using npm or yarn:

bash
npm install @open-nebel/nest-s3 @aws-sdk/client-s3 @aws-sdk/s3-request-presigner

or

bash
yarn add @open-nebel/nest-s3 @aws-sdk/client-s3 @aws-sdk/s3-request-presigner

Configuration

Configure the S3 module using synchronous or asynchronous methods to suit your application's needs. Detailed configuration instructions and examples are provided in the Configuration section.

Usage

Explore the comprehensive API provided by @open-nebel/nest-s3 to manage your S3 resources efficiently. The Usage section includes examples and best practices for integrating and utilizing the library's features.

With @open-nebel/nest-s3, you can effortlessly harness the power of AWS S3 within your NestJS applications, ensuring a robust, secure, and scalable storage solution.


Released under the MIT License.