Quickstart

📊 Univer Sheet📝 Univer Doc

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.

📊Univer Sheet

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.

Run the following command requires your device has nodejs >= 18, pnpm >= 7 and git installed.

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.

Integrated Server Template

Of course, 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. But don't worry, Univer has you covered! Follow the steps below to quickly experience these advanced features.

Install and Run the Server

bash -c "$(curl -fsSL https://get.univer.ai)"

⚠️

If you encounter any issues during installation or use, please refer to the Troubleshooting.

Install and Run the Frontend

Run the following command requires your device has nodejs >= 18, pnpm >= 7 and git installed.

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

⚠️

If you deploy the server on a different machine, you need to update the server configuration in vite.config.ts by changing localhost to the machine's IP address.

🎉 Congratulations! You've successfully created another Univer project with a server. You can now visit http://localhost:5173/ (opens in a new tab) to experience these advanced features.

You can also find the source code for this template at dream-num/univer-pro-sheet-start-kit (opens in a new tab).

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 & Usage: If you want to learn how to manually set up a Univer project from scratch, check out the Installation & 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.
🏗️ 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!

Roadmap Installation & Usage