Our web routing and API are defined by the OpenAPI specification. It defines the available web routes, API endpoints, handlers, requests, responses, and error objects. That gives us one source of truth for documentation, types, and routing.
Owncast is a growing open source project giving freedom, flexibility, and fun to live streamers. This is a starting point for anyone looking to contribute in any capacity.
A collection of design contribution guidelines and resources for the Owncast interface.
This document gets you up and running for Owncast development. If you want more on contributing in non-technical ways too, read the Contributor Guide.
Common terms you will run into around Owncast.
This is how we build components for the Owncast web UI. Use it when changing existing components or adding new ones. A shared pattern keeps the project readable and maintainable.
Owncast is a do-ocracy run by a small group of volunteers. New changes are always welcome, and a little process up front keeps things smooth for everyone.
Please provide improvements and be patient with this document as we work through all the different use cases when it comes to localizing strings in the web UI.
Owncast is spread across a few repositories. Knowing which one holds what saves a lot of searching.
Owncast now supports custom plugins.