Quickstart

If you want to get started with Univer as quickly as possible, you’ve come to the right place! This page will guide you through building a working Univer app in just a few minutes.

Play Online

You can play with Univer online without installing anything. Just click the link below and start using Univer right away.

Starter Kit

If you prefer to start with a local development environment, you can use the following starter kits to create a new Univer app in just a few seconds.

npx degit dream-num/univer-sheet-start-kit univer-sheet-start-kit
cd univer-sheet-start-kit
npm install
npm run dev

pnpm dlx degit dream-num/univer-sheet-start-kit univer-sheet-start-kit
cd univer-sheet-start-kit
pnpm install
pnpm dev

Great job on your first steps with Univer! You’ve successfully created your first project and gotten a taste of what Univer can do. You can find the source code for this template at dream-num/univer-sheet-start-kit.

From a Single HTML File

If you prefer not to use frontend development tools, you can download the following HTML file to get started quickly:

Next Steps

Congratulations on making it this far! You’re well on your way to mastering Univer. Here are some next steps to help you continue your journey:

• 🔰 Installation & Basic Usage: If you want to learn how to manually set up a Univer project from scratch, check out the Installation & Basic Usage chapter. It will guide you through the process step by step.
• 🧱 Basic Concepts: Read the Basic Concepts chapter to better understand the basic concepts that you’ll encounter repeatedly in Univer projects.
• 🌌 Pro Features: You may want more than just the basics. If you’re looking to add features like printing, importing/exporting, and collaborative editing, you’ll need additional configuration and server support. Please follow steps in Introduction to Pro Features
• 🏗️ Advanced Usage: Ready to take your Univer skills to the next level? The Advanced Usage chapter covers more advanced topics and techniques for working with Univer.
• 📚 Tutorials: Looking for practical examples and real-world use cases? Head over to the Tutorials chapter, where you’ll find a collection of hands-on tutorials that demonstrate how to build various applications and features with Univer.
• 🌌 Architecture: Want to dive deep into the inner workings of Univer? The Architecture chapter provides a comprehensive overview of Univer’s architecture, core concepts, and design principles.
• 🎢 Playground: Don’t forget to explore the Playground page, where you can experiment with various Univer demos and see the library in action.

No matter which path you choose, Univer is here to support you every step of the way. Happy coding!