AFFiNE README

The project's README from github.com/toeverything/AFFiNE. As one markdown file: README.md.

AFFiNE.Pro
Write, Draw and Plan All at Once

affine logo

A privacy-focused, local-first, open-source, and ready-to-use alternative for Notion & Miro.
One hyper-fused platform for wildly creative minds.



AFFiNE - One app for all - Where Notion meets Miro | Product Hunt

Home Page | Discord | Live Demo | Blog | Documentation

Releases All Contributors TypeScript-version-icon


Docs, canvas and tables are hyper-merged with AFFiNE - just like the word affine (əˈfʌɪn | a-fine).

Getting started & staying tuned with us.

Star us, and you will receive all release notifications from GitHub without any delay!

What is AFFiNE

AFFiNE is an open-source, all-in-one workspace and an operating system for all the building blocks that assemble your knowledge base and much more -- wiki, knowledge management, presentation and digital assets. It's a better alternative to Notion and Miro.

Features

A true canvas for blocks in any form. Docs and whiteboard are now fully merged.

Multimodal AI partner ready to kick in any work

Local-first & Real-time collaborative

Self-host & Shape your own AFFiNE

Acknowledgement

“We shape our tools and thereafter our tools shape us”. A lot of pioneers have inspired us along the way, e.g.:

There is a large overlap of their atomic “building blocks” between these apps. They are not open source, nor do they have a plugin system like Vscode for contributors to customize. We want to have something that contains all the features we love and also goes one step even further.

Thanks for checking us out, we appreciate your interest and sincerely hope that AFFiNE resonates with you! 🎵 Checking https://affine.pro/ for more details ions.

Contributing

Bug Reports Feature Requests Questions/Discussions AFFiNE Community
Create a bug report Submit a feature request Check GitHub Discussion Visit the AFFiNE's Discord
Something isn't working as expected An idea for a new feature, or improvements Discuss and ask questions A place to ask, learn and engage with others

Calling all developers, testers, tech writers and more! Contributions of all types are more than welcome, you can read more in docs/types-of-contributions.md. If you are interested in contributing code, read our docs/CONTRIBUTING.md and feel free to check out our GitHub issues to get stuck in to show us what you’re made of.

Before you start contributing, please sign our Contributor License Agreement — it takes less than a minute with your GitHub account. Pull requests cannot be merged until every committer has signed (the license/cla check on your PR). Full text: CLA.md.

For bug reports, feature requests and other suggestions you can also create a new issue and choose the most appropriate template for your feedback.

For translation and language support you can visit our Discord.

If you have questions, you are welcome to contact us. One of the best places to get more info and learn more is in the Discord where you can engage with other like-minded individuals.

Templates

AFFiNE now provides pre-built templates from our team. Following are the Top 10 most popular templates among AFFiNE users,if you want to contribute, you can contribute your own template so other people can use it too.

Blog

Welcome to the AFFiNE blog section! Here, you’ll find the latest insights, tips, and guides on how to maximize your experience with AFFiNE and AFFiNE AI, the leading Canvas AI tool for flexible note-taking and creative organization.

Ecosystem

Name
@affine/component AFFiNE Component Resources
@toeverything/theme AFFiNE theme

Upstreams

We would also like to give thanks to open-source projects that make AFFiNE possible:

Thanks a lot to the community for providing such powerful and simple libraries, so that we can focus more on the implementation of the product logic, and we hope that in the future our projects will also provide a more easy-to-use knowledge base for everyone.

Contributors

We would like to express our gratitude to all the individuals who have already contributed to AFFiNE! If you have any AFFiNE-related project, documentation, tool or template, please feel free to contribute it by submitting a pull request to our curated list on GitHub: awesome-affine.

contributors

Self-Host

Begin with Docker to deploy your own feature-rich, unrestricted version of AFFiNE. Our team is diligently updating to the latest version. For more information on how to self-host AFFiNE, please refer to our documentation.

Deploy to Render

Run on Sealos

Feature Request

For feature requests, please see discussions.

Building

Codespaces

From the GitHub repo main page, click the green "Code" button and select "Create codespace on master". This will open a new Codespace with the (supposedly auto-forked AFFiNE repo cloned, built, and ready to go).

Local

See BUILDING.md for instructions on how to build AFFiNE from source code.

Contributing

We welcome contributions from everyone. See docs/contributing/tutorial.md for details.

License

Editions

See LICENSE for details.

AFFiNE (toeverything/AFFiNE)

Searching Database…

73.6K ·GitHub
What is this?AFFiNE is an open-source, all-in-one workspace that merges docs, whiteboards and tables into one knowledge base, positioned as a privacy-first alternative to Notion and Miro.
Is this a note-taking app or a developer library?It is a ready-to-use application, not a library: you run it as a web client or an Electron desktop app for macOS, Windows and Linux.
How do I get AFFiNE running?You can self-host it with Docker, use the hosted cloud version, or build it from source following BUILDING.md for local development.
Does self-hosting give me every feature?Only the Community Edition (CE) is available today under MIT; the Enterprise Edition with SSO, advanced admin and audit features is not published yet.
Where can I actually use AFFiNE?It runs in the browser as a web app and as a native desktop app (via Electron) on macOS, Windows and Linux.
Does my data stay local or go to a server?AFFiNE is local-first, meaning you own your data on disk, with optional real-time sync and collaboration layered on top rather than being cloud-mandatory.
What makes AFFiNE's editor different from a regular note app?Docs and whiteboard are fully merged into one edgeless canvas, so you can place rich text, sticky notes, embedded web pages, multi-view databases, shapes and slides all on the same surface.
What is AFFiNE AI?It is a built-in multimodal AI assistant that can turn outlines into slides, summarize articles into mindmaps, draft reports, and even help prototype apps from a single prompt.
What open-source pieces power AFFiNE under the hood?It is built on BlockSuite (the collaborative editor engine), y-octo (a Rust CRDT implementation of Yjs), OctoBase (a Rust local-first database), React and Electron.
Can I start from a pre-made layout instead of a blank page?Yes, the AFFiNE team ships pre-built templates such as vision boards, lesson plans, Cornell notes and digital planners that you can use or contribute to.
What are similar projects?docs, docmost, EverRoom, Trilium, open-knowledge, macro, AppFlowy, solomd
Size
444.3 MB
Stars
73.6K
Age
4y
Commits · 90 Days