Skip to content

dropkit-app/dropkit-js

Repository files navigation

dropkit-js

Official JavaScript/TypeScript client libraries for dropkit: file upload API and CDN.

This repo is a monorepo. The dropkit service itself is proprietary; the client libraries here are MIT-licensed so you can read them, fork them, and ship them in your app.

Packages

package description
@dropkit/sdk Upload files, sign private URLs, delete. Works in browsers, Node, Bun, Deno, Cloudflare Workers, Vercel Edge.
@dropkit/cli npx @dropkit/cli init to wire dropkit into any JS/TS project. dropkit upload <file> for one-off uploads (zero signup via the public demo).

Quick start

Zero-signup demo, no account needed:

npx @dropkit/cli@latest upload ./photo.png

Install into a project:

npx @dropkit/cli@latest init

SDK usage:

import { dropkit } from '@dropkit/sdk';

const client = dropkit({ key: process.env.DROPKIT_KEY });

const { data, error } = await client.upload(file);
if (error) throw new Error(error.message);
console.log(data.url);

Docs

Full docs at https://dropkit.app/docs. Agents and LLMs: read https://dropkit.app/llms.txt.

Contributing

Bugs and feature requests: open an issue. For new framework bindings (@dropkit/react, @dropkit/nextjs, @dropkit/svelte), open a discussion first so we can coordinate the API surface.

Development

bun install
bun run typecheck
bun run build

We use changesets for releases. After a change that affects a public package:

bun run changeset

Follow the prompt, commit the generated file, and open a PR. Merging triggers the release workflow.

License

MIT. See LICENSE.

The dropkit service (storage-service) is closed-source; the libraries in this repo are not.

About

Official JavaScript/TypeScript SDK and CLI for dropkit. File upload API and CDN.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors