https://github.com/canvydocs/canvydocs
Open source Miro alternative
https://github.com/canvydocs/canvydocs
collaboration diagramming documents google-docs mind-mapping note-taking notion project-management whiteboard wiki wireframing word-microsoft
Last synced: 11 days ago
JSON representation
Open source Miro alternative
- Host: GitHub
- URL: https://github.com/canvydocs/canvydocs
- Owner: CanvyDocs
- License: agpl-3.0
- Created: 2024-08-20T23:20:14.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-08-26T17:40:00.000Z (8 months ago)
- Last Synced: 2025-03-23T21:45:51.007Z (28 days ago)
- Topics: collaboration, diagramming, documents, google-docs, mind-mapping, note-taking, notion, project-management, whiteboard, wiki, wireframing, word-microsoft
- Language: TypeScript
- Homepage: https://canvydocs.com
- Size: 2.14 MB
- Stars: 27
- Watchers: 1
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.MD
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
CanvyDocs
The Open Source Miro Alternative.
## 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
- 🔷 [TypeScript](https://www.typescriptlang.org/) - Language
- ⚡ [Next.js](https://nextjs.org/) - Framework
- 🗄️ [Prisma](https://www.prisma.io/) - ORM
- 🎨 [Tailwind CSS](https://tailwindcss.com/) - CSS
- 🧱 [shadcn/ui](https://ui.shadcn.com/) - Component Library
- 🔐 [NextAuth.js](https://next-auth.js.org/) - Authentication
- 📧 [react-email](https://react.email/) - Email Templates
- 🔄 [tRPC](https://trpc.io/) - API
- 🖌️ [Excalidraw](https://excalidraw.com/) - Whiteboarding and Diagramming
- 📝 [EditorJS](https://editorjs.io/) - Rich Text Editing
- 💳 [Stripe](https://stripe.com/) - Payments
- 🚀 [Vercel](https://vercel.com/) - Hosting
## Getting Started (Coming soon)
### Prerequisites
Make sure you have [Bun](https://bun.sh/) installed:
Make sure you have bun installed
```bash
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:
```bash
cp .env.example .env.local
```
2. Run the development server:
```bash
bun run dev:web
```
3. Open [http://localhost:3000](http://localhost:3000) in your browser to see the result.
4. (Optional)Install tailwind config viewer: `bun run tailwind-config-viewer` Open [http://localhost:3333](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](https://discord.gg/canvydocs)