Skip to content

CanvyDocs/CanvyDocs

Repository files navigation

CanvyDocs Logo

CanvyDocs

The Open Source Miro Alternative.

CanvyDocs is released under the AGPL-3.0 license. PRs welcome! Discord Chat

WebsiteIssuesRoadmap

About CanvyDocs

CanvyDocs is an open-source alternative to Miro, providing a powerful platform for planning, tracking, and collaborating on documents using an infinite canvas. Our goal is to offer a feature-rich, customizable solution for teams and individuals who need a flexible workspace for their ideas and projects.

Join us in creating the next generation of open collaboration infrastructure.

Features

  • 🚀 Infinite canvas for unlimited creativity
  • 📝 Rich text editing and document collaboration
  • 🔗 Real-time collaboration
  • 🎨 Customizable templates and shapes
  • 📊 Integration with popular tools and services
  • 🔒 Self-hosted option for data privacy

Tech Stack

Getting Started (Coming soon)

Prerequisites

Make sure you have Bun installed:

Make sure you have bun installed

bun --version
# if not installed, follow the instructions here: https://bun.sh/docs/installation

Setup

Follow these steps to set up your project:

  1. Set up the environment variables:
cp .env.example .env.local
  1. Run the development server:
bun run dev:web
  1. Open http://localhost:3000 in your browser to see the result.

  2. (Optional)Install tailwind config viewer: bun run tailwind-config-viewer Open http://localhost:3333 in your browser to see your Tailwind CSS configuration

📦 Apps and Packages

  • web: The main Next.js application
  • ui: Shared UI components
  • db: Database schema and utilities
  • auth: Authentication utilities
  • email: Email templates and utilities

Self Hosting

Self hosting docs coming soon

Developer setup

Coming soon

Discord

Join our Discord server to stay up to date with the latest news and updates: Join Discord