Overview - Developer Guidelines
OpenQuok's developer guidelines — fork the repo, submit code PRs, security, RBAC, and theming conventions.
1 min read
Connect your agent today
Draft from chat, review in your calendar, and publish only what you approve.
Developer Guidelines
This section collects engineering guidelines for contributing code to OpenQuok — from opening a pull request to conventions that are easy to forget during day-to-day work (RBAC, SSR security constraints, and secret-handling rules).
Contribution guides
Pick scoped product work, publish catalog listings, or author documentation for the docs site.
Contribution opportunities
Scoped product work — social providers, Humanizer locales, and docs translations
Publish listings
Share building blocks and playbooks on the OpenQuok catalog
Documentation contribution
Author docs pages, preview locally, and submit a PR
Engineering guidelines
Conventions for code contributions — pull requests, security, RBAC, theming, notifications, and workers.
Submit a pull request
Fork the repo, run checks locally, and open a code PR on GitHub
Security guidelines
Service key rules, RLS guidance, and SSR state management safety
RBAC (roles & permissions)
How app-level roles/permissions work and how to secure routes correctly
DaisyUI theming
Semantic color classes, theme-safe UI tokens, and shadcn-to-DaisyUI mapping
Notifications
In-app notifications + notification email (immediate vs digest), workers, and troubleshooting
Orchestrator workflows
Flowcraft integration refresh, notification email, scheduled posts—in-process or BullMQ
Related Section(s)
More guides and operator setup on Self-hosting.
Publish listings
Share building blocks and playbooks on the OpenQuok catalog
Documentation contribution
Author docs pages, preview locally, and submit a PR
Contribution opportunities
Scoped product work — social providers, Humanizer locales, and docs translations
Submit a pull request
Fork the repo, run checks locally, and open a code PR on GitHub
Self-hosting overview
Architecture, quick start, and operator defaults
Configuration - Backend
Supabase, env vars, and backend operational setup
Configuration - Worker
Worker env, Railway, and production start commands
Configuration - Web
Vite env vars and web configuration
General
What OpenQuok is and how to use the social scheduler
Public API
Posts, channels, and analytics over HTTP