README.md
April 15, 2026 ยท View on GitHub
SnowShare
SnowShare is a modern, secure file and link sharing platform built with Next.js, Prisma, and NextAuth.
It provides a clean, user-friendly interface for sharing URLs, text snippets, and files with customizable options for expiration, privacy, and access.
Features โจ
LinkShare ๐
- Share any URL with a customizable shortened link
- Set expiration times (1 day to solar explosion) โณ
- Option for no expiration (authenticated users)
- Custom slugs for personalized links
- Password protection for enhanced security ๐
- Instant QR code generation for shared links ๐ฑ
PasteShare ๐
- Share code snippets and text with syntax highlighting ๐จ
- Support for multiple programming languages
- Expiration options and password protection ๐
- Ideal for sharing code samples, configuration files, or any text content
FileShare ๐
- Secure file uploads with size limits
- Automatic file type detection
- Download tracking ๐ฅ
- Same expiration and protection features
User Management ๐ฅ
-
User registration and authentication via NextAuth ๐
-
Frontend: Next.js 16, React 19.1, TailwindCSS 4
-
Authentication: NextAuth.js with bcrypt password hashing
-
Special Features: QR code generation, custom URL slugs
Getting Started ๐
- Node.js 24+ and npm/yarn
- PostgreSQL database
Prerequisites โ
-
Node.js 24+ and npm/yarn
-
PostgreSQL database
-
Node.js 24+ and npm/yarn
-
PostgreSQL database
Installation ๐ ๏ธ
-
Clone the repository
git clone https://github.com/TuroYT/snowshare cd snowshare -
Install dependencies
npm install -
Set up environment variables Create a
.envfile in the root directory with the following variables:# Database DATABASE_URL="postgresql://username:password@localhost:5432/snowshare" # NextAuth NEXTAUTH_URL="http://localhost:3000" NEXTAUTH_SECRET="your-secret-key" # Auth (allow or disallow user signups) ALLOW_SIGNUP=true
Docker
Quick start (Docker Hub)
The easiest way to run SnowShare โ no build needed, PostgreSQL included.
Option A โ docker-compose (recommended)
- Create a
docker-compose.yml:
version: "3.9"
services:
db:
image: postgres:16-alpine
restart: unless-stopped
environment:
POSTGRES_USER: postgres
POSTGRES_PASSWORD: postgres
POSTGRES_DB: snowshare
volumes:
- db-data:/var/lib/postgresql/data
healthcheck:
test: ["CMD-SHELL", "pg_isready -U postgres"]
interval: 5s
timeout: 5s
retries: 10
app:
image: turodev/snowshare:latest
restart: unless-stopped
depends_on:
db:
condition: service_healthy
environment:
DATABASE_URL: postgres://postgres:postgres@db:5432/snowshare
NEXTAUTH_URL: http://localhost:3000 # Change to your public URL
NEXTAUTH_SECRET: changeme-replace-with-random-secret # Change this!
ALLOW_SIGNUP: "true"
ports:
- "3000:3000"
volumes:
- uploads:/app/uploads
volumes:
db-data:
uploads:
- Start the stack:
docker compose up -d
Option B โ docker run
Start PostgreSQL first:
docker run -d \
--name snowshare-db \
--network snowshare-net \
-e POSTGRES_USER=postgres \
-e POSTGRES_PASSWORD=postgres \
-e POSTGRES_DB=snowshare \
-v snowshare-db:/var/lib/postgresql/data \
postgres:16-alpine
Then start SnowShare:
docker network create snowshare-net
docker run -d \
--name snowshare \
--network snowshare-net \
-p 3000:3000 \
-e DATABASE_URL="postgres://postgres:postgres@snowshare-db:5432/snowshare" \
-e NEXTAUTH_URL="http://localhost:3000" \
-e NEXTAUTH_SECRET="$(openssl rand -base64 32)" \
-e ALLOW_SIGNUP="true" \
-v snowshare-uploads:/app/uploads \
turodev/snowshare:latest
The app will be available at http://localhost:3000.
Note: Change
NEXTAUTH_URLto your public domain and use a strongNEXTAUTH_SECRET(generate one withopenssl rand -base64 32).
Available tags: latest, 1.3.9, 1.3
Build from source
docker compose up -d --build
-
Initialize the database
npx prisma migrate dev -
Start the development server
npm run dev -
Open http://localhost:3000 with your browser to see the result.
Project Structure ๐๏ธ
/
โโโ prisma/ # Prisma schema and migrations
โโโ public/ # Static assets
โโโ src/
โโโ app/ # Next.js App Router structure
โ โโโ api/ # API routes
โ โโโ auth/ # Authentication pages
โ โโโ protected/ # Protected slugs and shares
โ โโโ s/ # Short link redirects
โโโ components/ # React components
โโโ hooks/ # Custom React hooks
โโโ lib/ # Utility functions and shared code
๐ Acknowledgments
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
License โ๏ธ
This project is licensed under the MIT License - see the LICENSE file for details.
Privacy & Analytics ๐
SnowShare uses Plausible Analytics for privacy-friendly, cookie-free usage statistics. Plausible is:
- GDPR compliant โ No personal data collected
- Cookie-free โ No consent banner needed
- Open source โ Transparent and auditable
No personally identifiable information is collected. Analytics help us understand usage patterns to improve the project.
To disable telemetry, add to your .env:
TELEMETRY=false
To use your own Plausible instance:
PLAUSIBLE_DOMAIN=your-domain.com
PLAUSIBLE_HOST=https://your-plausible-instance.com
Star History
Acknowledgments / Credits ๐
- Next.js - The React Framework
- Prisma - Next-generation ORM
- NextAuth.js - Authentication for Next.js
- TailwindCSS - Utility-first CSS framework