Skip to content

docs(landing): claim-integrity pass — truthful wording for parity, providers, Node version, privacy and README #418

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
BSalaeddin wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

docs(landing): claim-integrity pass — truthful wording for parity, providers, Node version, privacy and README #418

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 12 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,11 @@
<h3 align="center">One file uploader. Every framework.</h3>

<p align="center">
A headless upload engine with native, byte-identical UI packages for
A headless upload engine with native, DOM-identical UI packages for
<b>React</b>, <b>Vue</b>, <b>Svelte</b>, <b>Angular</b>, <b>Vanilla&nbsp;JS</b>, and <b>Preact</b> —
with optional server-mode uploads, cloud drives, camera, screen capture, and link imports.
</p>

<!-- npm badges: add after first @useupup publish -->
<p align="center">
<a href="https://github.com/DevinoSolutions/upup/actions/workflows/main.yml"><img src="https://github.com/DevinoSolutions/upup/actions/workflows/main.yml/badge.svg" alt="CI" /></a>
<a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT" /></a>
Expand All @@ -31,15 +30,15 @@
**upup** is a free, MIT-licensed file uploader built as one headless
[`@useupup/core`](packages/core) engine with a matching native UI for every major
framework. React is the visual canon; the Vue, Svelte, Angular, Vanilla, and
Preact ports render the **same DOM** with the **same props**, verified
byte-for-byte by a cross-framework parity harness. Upload straight from the
browser to any S3-compatible storage (Client Mode), or route through your own
backend with an HMAC-signed trust model (Server Mode via
[`@useupup/server`](packages/server)).
Preact ports render the **same DOM** with the **same props**, verified by a
cross-framework parity harness (structure, classes, accessibility attributes,
text). Upload straight from the browser to any S3-compatible storage (Client
Mode), or route through your own backend with an HMAC-signed trust model
(Server Mode via [`@useupup/server`](packages/server)).

## Install

Pick the package for your framework — the component API and rendered DOM are identical across all of them:
Pick the package for your framework — the component API and the rendered DOM contract are identical across all of them:

| Package | Install | Get started |
| ------------------ | ------------------------ | ------------------------------------------------------------------ |
Expand Down Expand Up @@ -113,7 +112,7 @@ Express, Fastify, and Hono handlers ship as subpath exports
## Features

- **Headless core.** `@useupup/core` is a zero-framework-dependency engine: file state, an upload pipeline (compression, HEIC→JPEG, EXIF stripping, checksums, thumbnails, optional Web Worker offload), cloud-drive plugins, i18n, and theming. Build your own UI on it, or use a native package.
- **Native UI for six frameworks.** React, Vue, Svelte, Angular, Vanilla JS, and Preact — same DOM, same Tailwind classes, enforced byte-for-byte by a parity harness.
- **Native UI for six frameworks.** React, Vue, Svelte, Angular, Vanilla JS, and Preact — same DOM structure, same `upup-` classes, enforced by a cross-framework parity harness.
- **Client or Server mode.** Direct browser → storage presigned uploads, or a server-proxied [`@useupup/server`](packages/server) with an HMAC-signed trust model (signed length, key/uploadId binding, mandatory secrets).
- **S3-compatible storage.** AWS S3, Cloudflare R2, MinIO, DigitalOcean Spaces, Backblaze B2, Wasabi — any S3-compatible endpoint.
- **Cloud drives.** Import from Google Drive, OneDrive, Dropbox, and Box, in client or server mode.
Expand All @@ -123,7 +122,10 @@ Express, Fastify, and Hono handlers ship as subpath exports
- **i18n & theming.** ICU-based localization with 9 bundled locales and RTL support, plus a slot-level theming system that targets every rendered element.
- **TypeScript-first.** Full type definitions out of the box.

## Battle-tested in production
## Used in production

Both apps below run the upup v3.1 engine under its previous `@upupjs/*` scope —
the same codebase, published before the rename to `@useupup/*`.

- **uNotes** — AI doc uploads for past exams → [unotes.net](https://unotes.net)
- **Shorty** — media uploads for transcripts → [aishorty.com](https://aishorty.com)
Expand Down
18 changes: 9 additions & 9 deletions apps/landing/content/docs/comparisons/upup-vs-filepond.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ capture, and an S3-compatible server with an HMAC-signed trust model.

## At a glance

| Feature | FilePond | upup |
| ----------------------------- | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
| Native first-party UI | Vanilla JS core + adapters: React, Vue, Angular, Svelte, jQuery | React, Vue, Svelte, Angular, Vanilla JS, Preact |
| Feature | FilePond | upup |
| ----------------------------- | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------- |
| Native first-party UI | Vanilla JS core + adapters: React, Vue, Angular, Svelte, jQuery | React, Vue, Svelte, Angular, Vanilla JS, Preact |
| Headless core | No — renders its own UI component | Yes (`@useupup/core`) |
| License / pricing | MIT, free & open source (the Pintura image editor is a separate commercial product) | MIT, free & open source |
| License / pricing | MIT, free & open source (the Pintura image editor is a separate commercial product) | MIT, free & open source |
| Self-host incl. S3-compatible | Yes — uploads to your own server endpoint (process / revert / restore), with chunk uploads; no built-in S3 signing | Yes — `@useupup/server` presigns and proxies to any S3-compatible storage |
| Cloud-drive sources | No (local files, directories, blobs, local/remote URLs, Data URIs, paste) | Google Drive, OneDrive, Dropbox, Box |
| Camera / screen capture | No | Yes (both) |
| Image editor | Via plugins (crop / resize / transform); a full editor is Pintura (separate/commercial) | Yes — React/Preact only |
| Resumable uploads | Chunked uploads (server-driven) | Yes — optional (tus or S3 multipart) |
| i18n | Configurable label strings (no locale bundles) | Yes (ICU locale bundles) |
| Cloud-drive sources | No (local files, directories, blobs, local/remote URLs, Data URIs, paste) | Google Drive, OneDrive, Dropbox, Box |
| Camera / screen capture | No | Yes (both) |
| Image editor | Via plugins (crop / resize / transform); a full editor is Pintura (separate/commercial) | Yes — React/Preact only |
| Resumable uploads | Chunked uploads (server-driven) | Yes — optional (tus or S3 multipart) |
| i18n | 48 locale files in `locale/`, plus configurable label strings | Yes (ICU locale bundles) |

## Choose FilePond if

Expand Down
20 changes: 10 additions & 10 deletions apps/landing/content/docs/comparisons/upup-vs-uploadthing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,18 @@ screen capture, image editing, and native UI for six frameworks.

## At a glance

| Feature | UploadThing | upup |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------- |
| Model | Hosted SaaS (managed storage + CDN) | Self-hosted library (your storage) |
| Native first-party UI | React components (`UploadButton` / `UploadDropzone`) + adapters for Next.js and other full-stack frameworks (Solid, Svelte, Vue, Nuxt, Expo, and more) | React, Vue, Svelte, Angular, Vanilla JS, Preact |
| Feature | UploadThing | upup |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------- |
| Model | Hosted SaaS (managed storage + CDN) | Self-hosted library (your storage) |
| Native first-party UI | React components (`UploadButton` / `UploadDropzone`) + adapters for Next.js and other full-stack frameworks (Solid, Svelte, Vue, Nuxt, Expo, and more) | React, Vue, Svelte, Angular, Vanilla JS, Preact |
| Headless core | React hooks (coupled to the service) | Yes (`@useupup/core`, framework-agnostic) |
| License / pricing | Open-source SDK (MIT); the service is a paid SaaS with a free tier and usage-based plans | MIT, free & open source (you pay only for your own storage) |
| License / pricing | Open-source SDK (MIT); the service is a paid SaaS with a free tier and usage-based plans | MIT, free & open source (you pay only for your own storage) |
| Storage / self-host | Managed — files are stored on UploadThing's infrastructure | Any S3-compatible storage you own (AWS, MinIO, R2, Spaces, Wasabi, Backblaze) via `@useupup/server` |
| Cloud-drive sources | No | Google Drive, OneDrive, Dropbox, Box |
| Camera / screen capture | No | Yes (both) |
| Image editor | No | Yes — React/Preact only |
| Resumable uploads | Not a primary feature | Yes — optional (tus or S3 multipart) |
| i18n | No | Yes (ICU locale bundles) |
| Cloud-drive sources | Not built in | Google Drive, OneDrive, Dropbox, Box |
| Camera / screen capture | Not built in | Yes (both) |
| Image editor | Not built in | Yes — React/Preact only |
| Resumable uploads | Yes — `createUpload` (start, pause, resume), since v7 | Yes — optional (tus or S3 multipart) |
| i18n | No | Yes (ICU locale bundles) |

## Choose UploadThing if

Expand Down
2 changes: 1 addition & 1 deletion apps/landing/content/docs/guides/reliability.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ all, tus remains the resumable option.
## A note on `fastAbortThreshold`

`fastAbortThreshold` is accepted by the core options and forwarded internally,
but nothing reads it in v3.1.0 — setting it has no effect on behavior. It is
but nothing reads it as of v3.3 — setting it has no effect on behavior. It is
documented here only so you do not spend an afternoon tuning a value that does
nothing. Use `maxRetries` to control how long upup persists on a failing file.

Expand Down
2 changes: 1 addition & 1 deletion apps/landing/content/docs/guides/server-auth.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ The token binds:
from `exp`, since `init` is the only issuer and has always used the same TTL.

It is signed with HMAC-SHA-256 over the payload using your
`uploadTokenSecret`, via Web Crypto (so it works on Node 18+, edge runtimes,
`uploadTokenSecret`, via Web Crypto (so it works on Node 20+, edge runtimes,
and Cloudflare Workers). On every continuation request the handler verifies the
signature **before** trusting any payload byte, compares it in constant time,
and checks expiry — the one exception being `resume`, which applies the resume
Expand Down
Loading
Loading