Quick start
Get going with Format in 5 mins.
Run the project creation script
If you're coming to Format without an existing codebase to install into, or just want to test the workflow for the first time, we'd recommend a standalone install. You will be prompted with a few questions and end up with a codebase that's ready to start developing Format documents.
If you want to install Format into an existing codebase or repo, you can follow the existing codebase guide instead.
npm create format@latestpnpm create format@latestyarn create format@latestbun create format@latestRun your project
After the setup is complete, you can run your project.
npm run devpnpm run devyarn devbun run devYou will be prompted to sign in to Format or create an account. Format Studio will then be launched on: http://localhost:1234.
Next steps
Learn the basics by building a document from scratch
This step-by-step tutorial shows you how to set page sizes, use pagination, add components, and more. It includes examples across all frameworks: HTML, React, and Vue.
Read about Studio
Start reading through our Studio docs to understand how to get the most out of designing your documents locally.
Explore deployment
Learn how to progress from designing locally to deploying your PDF generation to production systems and how to interact with our API.