# openflipbook

> Self-hosted, open-source flipbook.page alternative for exploring AI illustrations by clicking. Runs locally with Docker using your own API keys.

- **Category:** AI
- **Licence:** MIT
- **Open source:** oss
- **Languages:** Typescript, Python
- **Platforms:** Docker Compose
- **Tags:** Typescript, Next.js, Fastapi, Self Hosted, Generative Ai, Ai image generation, Openrouter, Infinite canvas, Gemini Api, Fal Ai, Flipbook, Ltx Video, Modal, Nano Banana, Vision Model, Byo Keys, Click To Explore, World Building

## Description

OpenFlipbook reimagines the flipbook.page concept as a self-hosted infinite canvas. Every page is a single AI-generated image; you start with a prompt or uploaded picture, then click anywhere to go deeper. A vision model interprets the click, a planner writes the next image request, and the cycle repeats. The stack runs locally via Docker Compose: a Next.js 15 frontend, a FastAPI backend (normally hosted on Modal but runnable locally), MongoDB for metadata, and RustFS as an S3-compatible blob store. All model calls use your own API keys — fal.ai for images, OpenRouter for the planner and click-resolution vision models. Features include swappable image providers with quality tiers, optional animation (one-shot MP4 or LTX streaming video), persistent permalinks that load from Mongo and object storage without re-generating, embeddable read-only worlds served over oEmbed or a simple script tag, a place inspector for renaming and locking locations, citations that surface source URLs, freehand region selection, a timeline scrubber, progressive rendering with a fast draft model, in-place editing with automated scoring, and a World Mode that treats pages as places on a persistent map. No built-in authentication exists; public deployments should be protected by a reverse proxy with TLS and auth. The codebase is MIT-licensed and under active development.

## Links

- [Homepage](https://github.com/eren23/openflipbook)
- [GitHub Repository](https://github.com/eren23/openflipbook)
- [Docker Compose Reference](https://github.com/eren23/openflipbook/blob/main/docs/DOCKER.md)
- [BYO Keys Walkthrough](https://github.com/eren23/openflipbook/blob/main/docs/BYO-KEYS.md)
- [Local Development Guide](https://github.com/eren23/openflipbook/blob/main/docs/LOCAL_DEV.md)
- [Embedding Worlds Guide](https://github.com/eren23/openflipbook/blob/main/docs/EMBEDDING.md)
- [Architecture Documentation](https://github.com/eren23/openflipbook/blob/main/docs/ARCHITECTURE.md)
- [Project Story & Reverse Engineering](https://github.com/eren23/openflipbook/blob/main/docs/STORY.md)
- [Roadmap](https://github.com/eren23/openflipbook/blob/main/docs/ROADMAP.md)

---
Source: https://selfhost.directory/project/openflipbook