Minimal is a bookmark management application built with modern web technologies. This guide will help you deploy and run Minimal on your own infrastructure.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/ephraimduncan/minimal.so/llms.txt
Use this file to discover all available pages before exploring further.
What is Minimal?
Minimal is a self-hostable bookmark manager that allows you to organize and manage your bookmarks with a clean, minimalist interface. It includes features like:- Bookmark organization with groups
- User authentication with email/password and OAuth
- Public bookmark sharing
- Chrome extension support
- SQLite/Turso database support
Architecture Overview
Minimal is built with the following technologies:- Framework: Next.js 16.1.1 (React 19.2.0)
- Database: SQLite/Turso with Prisma ORM
- Authentication: Better Auth
- Runtime: Bun or Node.js
- Styling: Tailwind CSS 4
- Storage: Vercel Blob (optional for avatars)
- Email: Autosend API (optional)
Key Features
Minimal requires minimal dependencies and can run on a single server with SQLite, or scale to production with Turso (distributed SQLite).
Database Options
- Local SQLite: Perfect for development and small deployments
- Turso: Distributed SQLite for production deployments with better scalability
Authentication Methods
- Email and password (built-in)
- Google OAuth (optional)
- Email verification
- Password reset functionality
Prerequisites
Before self-hosting Minimal, ensure you have:- Runtime: Bun 1.0+ or Node.js 20+
- Database: SQLite support (local file or Turso account)
- Domain: A domain name for production deployment (optional for local development)
- Email Service: Autosend API key for transactional emails (optional)
- OAuth: Google OAuth credentials (optional)
Quick Start
Configure environment variables
.env and configure required variables. See Configuration for details.Production Deployment
For production deployments, you’ll need to:- Set up a production database (Turso recommended)
- Configure environment variables for production
- Set up OAuth providers (optional)
- Configure email service for transactional emails
- Build and deploy the application
- Installation - Detailed installation steps
- Configuration - Environment variables and settings
- Database Setup - SQLite and Turso configuration
- Authentication - Better Auth configuration
System Requirements
Minimum Requirements
- CPU: 1 core
- RAM: 512 MB
- Storage: 1 GB (for application and database)
- Network: Internet connection for OAuth and email services
Recommended for Production
- CPU: 2+ cores
- RAM: 2 GB+
- Storage: 10 GB+
- Network: Stable internet connection with SSL/TLS certificate
Support and Community
If you encounter issues or have questions:- Check the documentation pages for detailed configuration guides
- Review the source code for implementation details
- Open an issue on GitHub for bugs or feature requests