Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/nayalsaurav/Storx/llms.txt

Use this file to discover all available pages before exploring further.

Storx is a full-stack cloud file storage and management application built with Next.js 15, Clerk authentication, ImageKit CDN, and Neon serverless PostgreSQL. It gives every authenticated user 15 GB of personal storage to upload images and PDFs, organize files into nested folders, star important items, and move unwanted files to the trash — all from a clean, responsive dashboard.

Key Features

File Uploads

Upload images (JPEG, PNG, WebP, GIF, SVG) and PDF files directly to ImageKit CDN. Files are stored under a per-user folder path and instantly accessible via a public URL.

Folder Organization

Create nested folders to keep your files structured. Every file and folder tracks its parent ID, so you can navigate deeply nested hierarchies from the dashboard.

Starred Files

Mark any file or folder as starred for quick access. The Starred section in the sidebar surfaces your most important files without leaving the dashboard.

Trash Management

Move files to the trash instead of deleting them immediately. Files in the trash can be permanently deleted or restored, giving you a safety net for accidental actions.

Grid & List Views

Switch between a grid view for visual browsing and a compact list view for density. Your preference persists across navigation so the dashboard always feels familiar.

Storage Indicator

A real-time storage progress bar in the sidebar shows how many bytes you have used out of your 15 GB quota, so you always know how much space remains.

Tech Stack

Storx is built on the Next.js 15 App Router, which co-locates server components, API route handlers, and client components in a single app/ directory. Authentication is handled entirely by Clerk — including sign-up, sign-in, session management, and middleware-level route protection — so no custom auth logic is required. Files are delivered through ImageKit, a real-time image and media CDN that stores assets under per-user folder paths (/storex/{userId}/) and generates thumbnail URLs automatically. The database layer uses Drizzle ORM with a Neon serverless PostgreSQL database: Drizzle provides a type-safe query API and a migration runner (db:migrate) that applies SQL migrations from the ./drizzle folder directly to your Neon project.

Prerequisites

Before running or deploying Storx, make sure you have the following:
  • Node.js 18 or later installed locally (the dev script uses Turbopack, which requires Node 18+)
  • A Clerk account at clerk.com to obtain your publishable key and secret key
  • An ImageKit account at imagekit.io to obtain your public key, private key, and URL endpoint
  • A Neon database at neon.tech with a PostgreSQL connection string available as DATABASE_URL

Next Steps

Quickstart

Clone the repository, configure your environment variables, run database migrations, and launch Storx locally in minutes.

Self-Hosting

Deploy Storx to production on Vercel with a Neon database, Clerk application, and ImageKit account fully configured.

Build docs developers (and LLMs) love