Skip to content

mini-vue

A minimal Vue 3 re-implementation for learning how Vue 3's core works.

Stars
10.5k
Forks
2.2k
Licence
MIT
Language
TypeScript
Last update
2.6 years ago
Type
Learning resource

No commits in over a year — check for forks or alternatives before adopting.

What it is

mini-vue is a stripped-down, teaching version of Vue 3 written in TypeScript. It keeps only the core logic (reactivity, runtime, and a basic compiler) and drops the edge-case handling found in the full Vue source, so readers can follow how Vue 3 works more easily. The README is primarily in Chinese and points to a paid video course that walks through building it step by step.

  • Reading a simplified reactivity system (reactive, ref, computed, effect) to see how dependency tracking works
  • Following the runtime-core flow for component initialization and updates
  • Studying the diff algorithm and compiler stages (parse, transform, codegen) at a small scale

Great for

  • Developers who want to understand Vue 3 internals before reading the real source
  • Learners who prefer writing code themselves to reading large codebases
  • Readers comfortable with Chinese-language documentation and videos

Not ideal for

  • People who just want to build apps with Vue; the README presents this as a learning project, not a production framework
  • Readers who need English documentation; the README links an English version but the course materials are in Chinese
Step-by-step guide: how to use mini-vueInstall, first run, examples, tips and FAQs

How to get it

  1. 1

    Clone and build from source

    You'll need: Node.js · pnpm

    Clone the repository

    git clone https://github.com/cuixiaorui/mini-vue

    Build the project

    pnpm build
  2. 2

    Run it

    • Clone the repository and install dependencies with pnpm
    • Run pnpm build
    • Serve the packages/vue/example/* index.html files from a local server (the README recommends Live Server)
    • Open the example pages in a browser to see the code run
  3. 3

    Get the most out of it

    • Follow the flow diagrams in the README (initialization and update) alongside the source
    • Use the function call graphs to search for function names in the code
    • Read the task checklist to see which Vue 3 features are implemented
    • Compare the code with the official Vue 3 source once you understand the basics

Downloads

Strengths

  • Keeps Vue 3 naming consistent with the real source, making it easier to search the original code
  • Covers the three core modules: reactivity, runtime, and compiler
  • Includes flow diagrams and function call graphs in the README

Trade-offs

  • The main course and video explanations are in Chinese and the full course is paid
  • The README does not describe the project as production-ready or list a release, so it is best treated as a study aid

Stats synced from GitHub. The assessment above was drafted with AI from the project's README on 2026-10-29 and may miss recent changes — check the README before relying on a command. MIT licence: free to use, modify and distribute, including commercially, as long as you keep the copyright notice.