https://github.com/becem-gharbi/nuxt-s3

Edge compatible S3 client for Nuxt
https://github.com/becem-gharbi/nuxt-s3

edge file-storage nuxt s3 serverless

Last synced: 2 months ago
JSON representation

Edge compatible S3 client for Nuxt

• Host: GitHub
• URL: https://github.com/becem-gharbi/nuxt-s3
• Owner: becem-gharbi
• License: mit
• Created: 2023-08-16T12:02:15.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-28T16:44:26.000Z (5 months ago)
• Last Synced: 2024-10-03T22:34:09.270Z (3 months ago)
• Topics: edge, file-storage, nuxt, s3, serverless
• Language: TypeScript
• Homepage: https://nuxt-s3.bg.tn
• Size: 3.77 MB
• Stars: 14
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Nuxt S3

[![npm version][npm-version-src]][npm-version-href]

[![npm downloads][npm-downloads-src]][npm-downloads-href]

[![License][license-src]][license-href]

[![Nuxt][nuxt-src]][nuxt-href]

S3 client for Nuxt with REST API thanks to [aws4fetch](https://github.com/mhart/aws4fetch).

## Features

- ✔️ Edge compatible

- ✔️ Object `upload` `remove` via `useS3Object` composable

- ✔️ Storage to filesystem as alternative

## Quick Setup

1. Add `@bg-dev/nuxt-s3` dependency to your project

```bash

# Using pnpm

pnpm add -D @bg-dev/nuxt-s3

# Using yarn

yarn add --dev @bg-dev/nuxt-s3

# Using npm

npm install --save-dev @bg-dev/nuxt-s3

```

### Documentation

The documentation website can be found [here](https://nuxt-s3.bg.tn)

## License

[MIT License](./LICENSE)

[npm-version-src]: https://img.shields.io/npm/v/@bg-dev/nuxt-s3/latest.svg?style=flat&colorA=18181B&colorB=28CF8D

[npm-version-href]: https://npmjs.com/package/@bg-dev/nuxt-s3

[npm-downloads-src]: https://img.shields.io/npm/dt/@bg-dev/nuxt-s3.svg?style=flat&colorA=18181B&colorB=28CF8D

[npm-downloads-href]: https://npmjs.com/package/@bg-dev/nuxt-s3

[license-src]: https://img.shields.io/npm/l/@bg-dev/nuxt-s3.svg?style=flat&colorA=18181B&colorB=28CF8D

[license-href]: https://npmjs.com/package/@bg-dev/nuxt-s3

[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js

[nuxt-href]: https://nuxt.com