Quickstart

​

Overview

ApexxCloud provides powerful cloud storage and media transformation capabilities. This guide will help you get started with:

• Setting up your SDK
• Uploading your first file
• Applying transformations
• Connecting external storage (optional)

​

Installation

Choose the SDK that best fits your needs:

npm install @apexxcloud/sdk-node    # For Node.js
npm install @apexxcloud/sdk-js      # For browser
npm install @apexxcloud/react       # For React

​

Quick Setup

​

Node.js

const ApexxCloud = require("@apexxcloud/sdk-node");

const storage = new ApexxCloud({
  accessKey: "your-access-key",
  secretKey: "your-secret-key",
  region: "APAC",
  bucket: "default-bucket",
});

​

Browser

import ApexxCloud from "@apexxcloud/sdk-js";

const storage = new ApexxCloud();

​

React

import { useApexxCloud } from "@apexxcloud/react";
import { useRef, useState } from "react";

function App() {
  const { upload, uploadMultipart } = useApexxCloud();

  //...
}

The useApexxCloud hook provides:

• Simple file upload handling
• Progress tracking
• Error handling
• Upload cancellation
• Multipart upload support

For more advanced usage, including the FileUploader component, check out the React SDK documentation.

​

External Storage Support

ApexxCloud supports connecting your existing storage buckets:

• AWS S3
• Cloudflare R2
• DigitalOcean Spaces

Learn more about connecting your external bucket.

​

Example Repository

Check out our example repository for a complete working implementation using our SDKs.

The example repository demonstrates:

• Basic file uploads
• Multipart uploads
• Transformation usage
• Error handling
• Progress tracking

​

Next Steps