Plane Developer Documentation
Official developer documentation for Plane - an open-source project management platform.
This repository contains comprehensive guides for REST API integration, self-hosting deployments, and building custom applications on the Plane platform.
- Self-Hosting - Deploy Plane on your own infrastructure with Docker, Kubernetes, or other platforms
- API Reference - Complete REST API documentation for integrating with Plane
- Developer Tools - Build custom apps, webhooks, and extensions
# Install dependencies
pnpm install
# Start development server
pnpm dev
# Build for production
pnpm build
# Preview production build
pnpm preview
The development server runs at http://localhost:5173 with hot reload enabled.
docs/
├── .vitepress/
│ ├── config.mts # VitePress configuration
│ ├── theme/ # Custom Vue theme
│ │ ├── components/ # Custom Vue components
│ │ └── style.css # Global styles
│ └── public/ # Static assets (images, logos)
├── api-reference/ # REST API documentation
├── self-hosting/ # Deployment and configuration guides
├── dev-tools/ # Developer tools and extensions
└── plane-one/ # Plane One (licensed edition) docs
See CONTRIBUTING.md for guidelines on contributing to this documentation.
Community
This project is licensed under the Apache License 2.0.