zpan

(โ˜… 2,058)

Lightweight file hosting platform built on top of S3-compatible storage

File Explorer

Download Latest Version (.zip)
  • .codecov.yml
  • .dependency-cruiser.cjs
  • .dev.vars.example
  • .dockerignore
  • .gitignore
  • .node-version
  • .npmrc
  • AGENTS.md
  • biome.json
  • CHANGELOG.md
  • CLAUDE.md
  • CODEOFCONDUCT.md
  • components.json
  • CONTRIBUTING.md
  • docker-compose.yml
  • Dockerfile
  • drizzle.config.ts
  • index.html
  • LICENSE
  • package.json
  • playwright.config.ts
  • pnpm-lock.yaml
  • README.md
  • SECURITY.md
  • tsconfig.depcruise.json
  • tsconfig.json
  • V2_ROADMAP.md
  • vite.config.ts
  • vitest.config.ts
  • wrangler.toml

# Installation Guide

1. Get the code
git clone https://github.com/saltbo/zpan

Downloads the entire project code from GitHub to your computer.

cd zpan

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
curl -O https://raw.githubusercontent.com/saltbo/zpan/main/deploy/docker-compose.yml

Runs the command against the services defined in the compose file.

docker compose up -d

Builds and starts all defined containers (server, database, etc.) at once, in the background.

curl -O https://raw.githubusercontent.com/saltbo/zpan/main/deploy/docker-compose.rustfs.yml

Runs the command against the services defined in the compose file.

docker compose -f docker-compose.rustfs.yml up -d

Runs the command against the services defined in the compose file.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

4. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
cd cmd

This project's files live in a subfolder, so move into it first.

go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

โœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.

Today's picks

clean-code-javascript โ˜… 94,761

Clean Code concepts adapted for JavaScript

JavaScript
manim โ˜… 91,823

Animation engine for explanatory math videos

Python
gemini-cli โ˜… 106,598

An open-source AI agent that brings the power of Gemini directly into your terminal.

TypeScript
skills โ˜… 170,812

Public repository for Agent Skills

Python
system-prompts-and-models-of-ai-tools โ˜… 142,968

FULL Augment Code, Claude Code, Cluely, CodeBuddy, Comet, Cursor, Devin AI, Junie, Kiro, L
reveal.js โ˜… 72,157

The HTML Presentation Framework

JavaScript
// repository documentation