Palmr/README.md

🌴 Palmr. - Open-Source File Transfer

Palmr. is a flexible and open-source alternative to file transfer services like WeTransfer, SendGB, Send Anywhere, and Files.fm.

⚠️ BETA VERSION

This project is currently in beta phase.
Not recommended for production environments.

🔗 For detailed documentation visit: Palmr. - Documentation

📌 Why Choose Palmr.?

• Self-hosted – Deploy on your own server or VPS.
• Full control – No third-party dependencies, ensuring privacy and security.
• No artificial limits – Share files without hidden restrictions or fees.
• Folder organization – Create folders to organize and share files.
• Simple deployment – SQLite database and filesystem storage for easy setup.
• Scalable storage – Optional S3-compatible object storage for enterprise needs.

🚀 Technologies Used

Palmr. is built with a focus on performance, scalability, and security.

Backend & API

• Fastify (Node.js) – High-performance API framework with built-in schema validation.
• SQLite – Lightweight, reliable database with zero-configuration setup.
• Filesystem Storage – Direct file storage with optional S3-compatible object storage.

Frontend

• NextJS 15 + TypeScript + Shadcn/ui – Modern and fast web interface.

🛠️ How It Works

1. Web Interface → Built with Next, React and TypeScript for a seamless user experience.
2. Backend API → Fastify handles requests and manages file operations.
3. Database → SQLite stores metadata and transactional data with zero configuration.
4. Storage → Filesystem storage ensures reliable file storage with optional S3-compatible object storage for scalability.

📸 Screenshots

Login Page	Home Page
Dashboard	Profile Page
Files List View	Files Card View
Shares Management	Receive Files
Reverse Share	Settings Panel
User Management	Forgot Password
Reverse Share (WeTransfer Style)

👨‍💻 Core Maintainers

Daniel Luiz Alves

🤝 Supporters

⭐ Star History

🛠️ Contributing

For contribution guidelines, please refer to the CONTRIBUTING.md file.