The open-source design system framework built for the future.

Mirrorful Cloud | Slack | Website | Documentation

Introduction

Mirrorful is an open-source design system framework that teams use to create and manage the building blocks of their app. Get started for free with Mirrorful Cloud.

✨ Features

• Design tokens — a single source of truth for your tokens.
• Theme generation — generate dark mode instantly.
• Component library agnostic — whether you’re a third-party or your in-house library, Mirrorful hooks right in.
• Eslint rules — detect hard-coded color strings throughout your project and help you convert them to the Mirrorful theme.
• Components — coming soon 👀

☁️ Get started

Check out our quickstart guide.

Mirrorful Cloud

The fastest way to get started with Mirrorful is with Mirrorful Cloud.

Alternatively, run Mirrorful locally:

To run Mirrorful locally, you need to run both the web project and the server.

git clone https://github.com/Mirrorful/mirrorful.git; cd mirrorful; cd apps/web; yarn; yarn dev

Visit localhost:3000. In a separate window, run the server at localhost:8080:

Before running the server, you'll need to install mongodb and run it in the background:

# from project root
cd packages/server; brew tap mongodb/brew; brew install mongodb-community@6.0; mongod --dbpath ./db/data

# from project root
cd packages/server; yarn; yarn dev

⭐ Open-source vs. paid

This repo is entirely MIT licensed. Need any integrations or want a new feature? Feel free to create an issue or contribute directly to the repository. The first draft of this README was made by a contributor!

To learn more, please visit our pricing page.

🛠️ Contributing

Whether it's big or small, we love contributions. Check out our contributing guide.

Community & Support

• Slack join our growing community!
• Issues report any bugs you encounter using Mirrorful.
• YouTube watch content about coding and design systems.
• Docs read our documentation.

Acknowledgements

The avatars of all contributors will be added here as a thank you. We are so appreciative of everyone who makes Mirrorful special. Be part of the movement! Join us on Slack and try out Mirrorful Cloud.