Storx is a self-hostable cloud file storage platform built with Next.js 15. It gives every authenticated user up to 15 GB of personal storage backed by ImageKit CDN, a Neon PostgreSQL database for metadata, and Clerk for secure authentication. Users can upload images and PDFs, organise them in nested folders, star favourites, and move files to trash — all from a responsive dashboard with grid and list views.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.
Introduction
Learn what Storx is, how it works, and what you’ll need before deploying.
Quickstart
Clone the repo, set your environment variables, and run Storx locally in minutes.
Self-Hosting
Deploy Storx to production on Vercel with a Neon database and ImageKit account.
API Reference
Explore every REST endpoint — files, folders, starring, trash, and storage auth.
Core Features
File Management
Upload, view, download, and delete images and PDFs with full CDN delivery.
Folder Organisation
Create nested folders and navigate with breadcrumb trails.
Starred Files
Mark important files as starred for quick access from the sidebar.
Trash
Soft-delete files to trash and restore or permanently remove them.
Configuration
Set up your database, ImageKit credentials, and Clerk keys.
Authentication
Clerk handles sign-up, sign-in, and route protection automatically.
Get Up and Running
Clone and install
Clone the Storx repository and install dependencies with your package manager of choice.
Configure environment variables
Add your Clerk, ImageKit, and Neon database credentials to
.env.local.Start the dev server
Run
npm run dev and open http://localhost:3000 to see Storx.