Overview
Development setup and API documentation for Wraft
Wraft Developer Guide
Wraft is an open-source Document Lifecycle Management tool built with Elixir and Phoenix that helps businesses produce their most important documents with complete control over the entire lifecycle.
🎯 Getting Started
Welcome to the Wraft Developer Guide! This documentation will help you understand the architecture, set up your development environment, and integrate with Wraft's APIs.
🏗️ Builder Setup
Set up the Wraft builder for local development and testing
🐳 Docker Deployment
Deploy Wraft using Docker Compose for easy containerized setup
☸️ Kubernetes
Deploy Wraft on Kubernetes for production environments
⚙️ Configuration & Environment
Configure Wraft for your specific environment and requirements.
🔧 Environment Variables
Configure Wraft using environment variables for different deployment scenarios
📝 Makefile Guide
Use our Makefile for common development tasks and automation
🔌 API & Integration
Integrate Wraft into your applications and workflows.
🛠️ Maintenance & Operations
Keep your Wraft installation up-to-date and running smoothly.
🤝 Contributing to Wraft
Wraft is open source and we welcome contributions from the community.
🏗️ Architecture Overview
Wraft is built on top of open formats, using Markdown and JSON to ensure your content is always accessible and future-proof. Our goal is to give people complete control over their most important documents, from drafting to collaborating and distributing.
Wraft's system architecture showing the relationship between frontend, backend, database, storage, and document processing components.
Key Technologies
- Backend: Elixir/Phoenix for robust, scalable web applications
- Database: PostgreSQL for reliable data storage
- Storage: S3-compatible storage for document and asset management
- Document Processing: Pandoc + LaTeX for high-quality PDF generation
- Containerization: Docker and Kubernetes support for flexible deployment