• luckybooru
  • Status
  • Goals and design principles
  • Dependencies
  • Deployment options
  • Database schema (WIP)
  • Source code and contributing

luckybooru

luckybooru is a danbooru-style booru written in Crystal with Lucky.

Status

luckybooru is in the early design stage.

Goals and design principles

• Feature parity with danbooru
• Support for various types of media (images, audio, videos, plaintext, Markdown)
• Full support for running in a cluster with live scaling
• All major features should work with no-JS/noscript and text browsers
• Fast on the server-side and on the client-side (no Python or Java)
• High configurability (deployment, user roles, analytics, danbooru-like premium account tiers)
• RESTful API with JSON output

Dependencies

• Crystal
• Lucky
• PostgreSQL
• Sentry (with raven.cr)
• Sonic (?)

Deployment options

We aim to support a variety of deployment options, including the following:

• Application: Kubernetes° (hosted, private cluster), manual Docker deployment, traditional server
• Database: PostgreSQL° (hosted or manual), CockroachDB
• File storage: S3 or S3-compatible object storage (e.g. MinIO)°, traditional filesystem

° preferred options

Database schema (WIP)

(click for full size)

Source code and contributing

Contributions in the form of issues (bug reports or feature requests) or pull requests on our repos are very welcome.

We also have an official development IRC channel: #luckybooru on irc.fuwafuwa.moe.

• Main repo: luckybooru
• Design documents (this page, database schema): luckybooru_info

All repos are licensed under the University of Illinois/NCSA Open Source License.