https://github.com/liam-edwards/adonisjs-cloudinary
AdonisJS Cloudinary
https://github.com/liam-edwards/adonisjs-cloudinary
Last synced: 3 months ago
JSON representation
AdonisJS Cloudinary
- Host: GitHub
- URL: https://github.com/liam-edwards/adonisjs-cloudinary
- Owner: liam-edwards
- License: mit
- Created: 2021-07-22T12:20:53.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-07-25T08:12:01.000Z (over 3 years ago)
- Last Synced: 2025-01-01T21:15:40.174Z (4 months ago)
- Language: TypeScript
- Size: 22.5 KB
- Stars: 10
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-adonisjs - AdonisJS Cloudinary - A Cloudinary wrapper for Adonis 5 (Packages)
README
# AdonisJS Cloudinary
[![npm-image]][npm-url] [![license-image]][license-url] [![typescript-image]][typescript-url]
A Cloudinary Wrapper for Adonis 5
## Installation
Install with either `npm` or `yarn`.
```bash
npm i adonisjs-cloudinary
yarn add adonisjs-cloudinary
```
And initialise the package
```bash
node ace configure adonisjs-cloudinary
```
## How to use
### Step 1: Get your API key and API secret
Upon creating a Cloudinary account, you will be given your API key and API secret. If you already have an account,
you can find these in your account settings under the "Security" section.
Your cloud name will be under found in the "Account" section of your settings.
### Step 2: Initialisation
Add variables to `.env` file of project.
```txt
...
CLOUDINARY_CLOUD_NAME=YOUR_CLOUD_NAME
CLOUDINARY_API_KEY=YOUR_KEY
CLOUDINARY_API_SECRET=YOUR_SECRET
```
### Step 3: Upload an image
You can upload an image to Cloudinary using the `upload` method passing in the file path and a public ID.
```ts
import cloudinary from '@ioc:Adonis/Addons/Cloudinary'
await cloudinary.upload(filePath, publicId)
```
You can alternatively pass in a file object
```ts
public async store({ request }: HttpContextContract) {
const file = request.file('your_file')
if (file) {
await cloudinary.upload(file, file.clientName)
}
}
```
The upload method returns an object the contains the image's public ID, URL, secure URL, and more if the upload is
successful.
### Step 4: Show your image
To get the URL for your image, you can use the `show` method, passing in your public ID and optionally an object
containing your transformation options.
```ts
const url = cloudinary.show('your_public_id')
```
By default, this method will use the transformation options found in the `cloudinary.ts` config file:
```ts
{
transformation: {
format: 'png',
},
width: 150,
height: 150,
crop: 'fit',
}
```
[npm-image]: https://img.shields.io/npm/v/adonisjs-cloudinary?logo=npm&style=for-the-badge
[npm-url]: https://www.npmjs.com/package/adonisjs-cloudinary
[license-image]: https://img.shields.io/npm/l/adonisjs-cloudinary?style=for-the-badge&color=blueviolet
[license-url]: https://github.com/liam-edwards/adonisjs-cloudinary/blob/master/LICENSE
[typescript-image]: https://img.shields.io/npm/types/adonisjs-cloudinary?color=294E80&label=%20&logo=typescript&style=for-the-badge
[typescript-url]: https://github.com/liam-edwards/adonisjs-cloudinar