mirror of
https://github.com/toeverything/AFFiNE.git
synced 2024-12-17 12:21:49 +03:00
9c50dbc362
feat(core): remove all imports from design/component feat(plugin): remove imports from design-components feat(storybook): remove design-components imoprts feat(core): remove fix(component): remove design/component import in local-demo-tip
237 lines
18 KiB
Markdown
237 lines
18 KiB
Markdown
<div align="center">
|
||
|
||
<h1 style="border-bottom: none">
|
||
<b><a href="https://affine.pro">AFFiNE.PRO</a></b><br />
|
||
Write, Draw and Plan All at Once
|
||
<br>
|
||
</h1>
|
||
|
||
<p>
|
||
One hyper-fused platform for wildly creative minds. <br />
|
||
A privacy-focussed, local-first, open-source, and ready-to-use alternative for Notion & Miro.
|
||
</p>
|
||
|
||
</div>
|
||
|
||
<div align="center">
|
||
|
||
[?style=flat-square&logoColor=white&logo=affine>)](https://app.affine.pro)
|
||
[](https://affine.pro/download)
|
||
[](https://affine.pro/download)
|
||
[](https://affine.pro/download)
|
||
[](https://affine.pro/download)
|
||
|
||
[](https://github.com/toeverything/AFFiNE/releases/latest)
|
||
[![stars-icon]](https://github.com/toeverything/AFFiNE)
|
||
[![All Contributors][all-contributors-badge]](#contributors)
|
||
[![codecov]](https://codecov.io/gh/toeverything/AFFiNE)
|
||
[![Node-version-icon]](https://nodejs.org/)
|
||
[![TypeScript-version-icon]](https://www.typescriptlang.org/)
|
||
[![React-version-icon]](https://reactjs.org/)
|
||
[![blocksuite-icon]](https://github.com/toeverything/blocksuite)
|
||
[![Rust-version-icon]](https://www.rust-lang.org/)
|
||
[](https://app.fossa.com/projects/git%2Bgithub.com%2Ftoeverything%2FAFFiNE?ref=badge_shield)
|
||
[](https://github.com/toeverything/AFFiNE/actions/workflows/deploy.yml)
|
||
|
||
</div>
|
||
|
||
---
|
||
|
||
<div align="center">
|
||
<a href="http://affine.pro"><img src="https://img.shields.io/badge/-AFFiNE-06449d?style=social&logo=affine" height=25></a>
|
||
|
||
<a href="https://community.affine.pro"><img src="https://img.shields.io/badge/-Community-424549?style=social&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAAXNSR0IArs4c6QAAAXNJREFUWEftlitLRUEURtdVEVExWUx2qxgNVouoXYtNDP4Tw20WtftAsItZrHaTYBJREZ98MAc248wcZxi4CGfSeezHmm/23kyPAa/egPPTAXQK/FsFBP7ldVDRZoqcgO9I+2bHy3ZIJBfTCPCZM1tqAxwBmzUBrNQNbEx+5b0B5oEN4NCBrAMnMaiUAuPAs3HU82TLEZwBqwGbaJ4UgKQ8CFR6SoEl4LIWwCJwZQCegKkWBWLHVKSActvdzgG3DqitDf3/VQBskBDALrDnAKXUo3ueAF5KinAf2DKOmnzD7l214bdbA6hC1XHZNQa8hSBC0hwDa57xDHDvvvWB7ciOZoE79+8CWPbsBGc769eFxJdWIKcuyIdRoG3W7AAC1dJkHDIOo8B78+4rEBo8r4AkLFk6Jk3HaeDBBTgHVmIAfpJUz+cAFXVBreQCvQYW/lqEjV1NAMUMqpAaxQMHyDnjYtuS+0BxstwaqJooFqxToFPgB5FuPCEB6XK2AAAAAElFTkSuQmCC" height=25></a>
|
||
|
||
<a href="https://discord.com/invite/yz6tGVsf5p"><img src="https://img.shields.io/badge/-Discord-424549?style=social&logo=discord" height=25></a>
|
||
|
||
<a href="https://t.me/affineworkos"><img src="https://img.shields.io/badge/-Telegram-red?style=social&logo=telegram" height=25></a>
|
||
|
||
<a href="https://twitter.com/AffineOfficial"><img src="https://img.shields.io/badge/-Twitter-red?style=social&logo=twitter" height=25></a>
|
||
|
||
<a href="https://medium.com/@affineworkos"><img src="https://img.shields.io/badge/-Medium-red?style=social&logo=medium" height=25></a>
|
||
</div>
|
||
|
||
<br />
|
||
<div align="center">
|
||
<em>Docs, canvas and tables are hyper-merged with AFFiNE - just like the word affine (əˈfʌɪn | a-fine).</em>
|
||
</div>
|
||
<br />
|
||
|
||
|
||
|
||
## Join our community
|
||
|
||
Before we tell you how to get started with AFFiNE, we'd like to shamelessly plug our awesome user and developer communities across [official social platforms](https://community.affine.pro/c/start-here/)! Once you’re familiar with using the software, maybe you will share your wisdom with others and even consider joining the [AFFiNE Ambassador program](https://community.affine.pro/c/start-here/affine-ambassador) to help spread AFFiNE to the world.
|
||
|
||
## Getting started & staying tuned with us.
|
||
|
||
⚠️ Please note that AFFiNE is still under active development and is not yet ready for production use. ⚠️
|
||
|
||
[](https://app.affine.pro) No installation or registration required! Head over to our website and try it out now.
|
||
|
||
[](https://community.affine.pro) Our wonderful community, where you can meet and engage with the team, developers and other like-minded enthusiastic user of AFFiNE.
|
||
|
||
Star us, and you will receive all releases notifications from GitHub without any delay!
|
||
|
||
|
||
## Features
|
||
|
||
- **Hyper merged** — Write, draw and plan all at once. Assemble any blocks you love on any canvas you like to enjoy seamless transitions between workflows with AFFiNE.
|
||
- **Privacy focussed** — AFFiNE is built with your privacy in mind and is one of our key concerns. We want you to keep control of your data, allowing you to store it as you like, where you like while still being able to freely edit and view your data on-demand.
|
||
- **Offline-first** — With your privacy in mind we also decided to go offline-first. This means that AFFiNE can be used offline, whether you want to view or edit, with support for conflict-free merging when you are back online.
|
||
- **Clean, intuitive design** — With AFFiNE you can concentrate on editing with a clean and modern interface. Which is responsive, so it looks great on tablets too, and mobile support is coming in the future.
|
||
- **Modern Block Editor with Markdown support** — A modern block editor can help you not only for docs, but slides and tables as well. When you write in AFFiNE you can use Markdown syntax which helps create an easier editing experience, that can be experienced with just a keyboard. And this allows you to export your data cleanly into Markdown.
|
||
- **Collaboration** — Whether you want to collaborate with yourself across multiple devices, or work together with others, support for collaboration and multiplayer is out-of-the-box, which makes it easy for teams to get started with AFFiNE.
|
||
- **Choice of multiple languages** — Thanks to community contributions AFFiNE offers support for multiple languages. If you don't find your language or would like to suggest some changes we welcome your contributions.
|
||
|
||
|
||
|
||
## Contributing
|
||
|
||
| Bug Reports | Feature Requests | Questions/Discussions | AFFiNE Community |
|
||
| --------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------- |
|
||
| [Create a bug report](https://github.com/toeverything/AFFiNE/issues/new?assignees=&labels=bug%2Cproduct-review&template=BUG-REPORT.yml&title=TITLE) | [Submit a feature request](https://github.com/toeverything/AFFiNE/issues/new?assignees=&labels=feat%2Cproduct-review&template=FEATURE-REQUEST.yml&title=TITLE) | [Check GitHub Discussion](https://github.com/toeverything/AFFiNE/discussions) | [Vist the AFFiNE Community](https://community.affine.pro) |
|
||
| 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](docs/types-of-contributions.md). If you are interested in contributing code, read our [docs/CONTRIBUTING.md](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 make sure you have read and accepted our [Contributor License Agreement]. To indicate your agreement, simply edit this file and submit a pull request.**
|
||
|
||
For **bug reports**, **feature requests** and other **suggestions** you can also [create a new issue](https://github.com/toeverything/AFFiNE/issues/new/choose) and choose the most appropriate template for your feedback.
|
||
|
||
For **translation** and **language support** you can visit our [i18n General Space](https://community.affine.pro/c/i18n-general).
|
||
|
||
Looking for **others ways to contribute** and wondering where to start? Check out the [AFFiNE Ambassador program](https://community.affine.pro/c/start-here/affine-ambassador), we work closely with passionate community members and provide them with a wide-range of support and resources.
|
||
|
||
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 [AFFiNE Community](https://community.affine.pro) where you can engage with other like-minded individuals.
|
||
|
||
## Ecosystem
|
||
|
||
| Name | | |
|
||
| -------------------------------------------------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||
| [@affine/component](packages/frontend/component) | AFFiNE Component Resources | [](https://affine-storybook.vercel.app/) |
|
||
| [@toeverything/y-indexeddb](packages/common/y-indexeddb) | IndexedDB database adapter for Yjs | [](https://www.npmjs.com/package/@toeverything/y-indexeddb) |
|
||
| [@toeverything/theme](packages/common/theme) | AFFiNE theme | [](https://www.npmjs.com/package/@toeverything/theme) |
|
||
|
||
## Plugins
|
||
|
||
> Plugins are a way to extend the functionality of AFFiNE. You can use plugins to add new blocks, new features, and even new ways to edit content.
|
||
>
|
||
> (Currently, the plugin system is under heavy development. You will see the plugin system in the canary release.)
|
||
|
||
- [@affine/sdk](./packages/common/sdk) - SDK for developing plugins
|
||
- [@affine/plugin-cli](./tools/plugin-cli) - CLI for developing plugins
|
||
|
||
| Official Plugin | Description | Status |
|
||
| ---------------------------------------------------------------- | ----------------------------------------- | ------ |
|
||
| [@affine/copilot-plugin](./packages/plugins/copilot) | AI Copilot that help you document writing | 🚧 |
|
||
| [@affine/image-preview-plugin](./packages/plugins/image-preview) | Component for previewing an image | ✅ |
|
||
| [@affine/outline](./packages/plugins/outline) | Outline for your document | ✅ |
|
||
|
||
## Upstreams
|
||
|
||
We would also like to give thanks to open-source projects that make AFFiNE possible:
|
||
|
||
- [blocksuite](https://github.com/toeverything/BlockSuite) - 💠 BlockSuite is the open-source collaborative editor project behind AFFiNE.
|
||
- [OctoBase](https://github.com/toeverything/OctoBase) - 🐙 OctoBase is the open-source database behind AFFiNE, local-first, yet collaborative. A light-weight, scalable, data engine written in Rust.
|
||
- [yjs](https://github.com/yjs/yjs) - Fundamental support of CRDTs for our implementation on state management and data sync.
|
||
- [electron](https://github.com/electron/electron) - Build cross-platform desktop apps with JavaScript, HTML, and CSS.
|
||
- [React](https://github.com/facebook/react) - The library for web and native user interfaces.
|
||
- [napi-rs](https://github.com/napi-rs/napi-rs) - A framework for building compiled Node.js add-ons in Rust via Node-API.
|
||
- [Jotai](https://github.com/pmndrs/jotai) - Primitive and flexible state management for React.
|
||
- [async-call-rpc](https://github.com/Jack-Works/async-call-rpc) - A lightweight JSON RPC client & server.
|
||
- [Vite](https://github.com/vitejs/vite) - Next generation frontend tooling.
|
||
- Other upstream [dependencies](https://github.com/toeverything/AFFiNE/network/dependencies).
|
||
|
||
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](https://github.com/toeverything/awesome-affine).
|
||
|
||
<a href="https://github.com/toeverything/affine/graphs/contributors">
|
||
<img alt="contributors" src="https://opencollective.com/affine/contributors.svg?width=890&button=false" />
|
||
</a>
|
||
|
||
## Data Compatibility
|
||
|
||
Data compatibility is a very important issue for us. We will try our best to ensure that the data is compatible with the previous version.
|
||
|
||
If you encounter any problems when upgrading the version, please feel free to [contact us](mailto:developer@toeverything.info).
|
||
|
||
| AFFiNE Version | Export/Import workspace | Data auto migration |
|
||
| --------------- | ----------------------- | ------------------- |
|
||
| <= 0.5.4 | ❌️ | ❌ |
|
||
| 0.6.x | ✅️ | ✅ |
|
||
| 0.7.x | ✅️ | ✅ |
|
||
| 0.8.x (current) | ✅ | ✅ |
|
||
| 0.9.x (next) | 🚧 | 🚧 |
|
||
|
||
- ❌️: Not compatible
|
||
- ✅: Compatible
|
||
- 🚧: Work in progress
|
||
|
||
## Self-Host
|
||
|
||
> We know that the self-host version has been out of date for a long time.
|
||
>
|
||
> We are working hard to get this updated to the latest version, you can try our desktop version first.
|
||
|
||
Get started with Docker and deploy your own feature-rich, restriction-free deployment of AFFiNE.
|
||
We are working hard to get this updated to the latest version, you can keep an eye on the [latest packages].
|
||
|
||
## Hiring
|
||
|
||
Some amazing companies including AFFiNE are looking for developers! Are you interested in helping build with AFFiNE and/or its partners? Check out some of the latest [jobs available].
|
||
|
||
## Upgrading
|
||
|
||
For upgrading information, please see our [update page].
|
||
|
||
## Feature Request
|
||
|
||
For feature request, please see [community.affine.pro](https://community.affine.pro/c/feature-requests/).
|
||
|
||
## 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](./docs/contributing/tutorial.md) for details.
|
||
|
||
## Thanks
|
||
|
||
<a href="https://www.chromatic.com/"><img src="https://user-images.githubusercontent.com/321738/84662277-e3db4f80-af1b-11ea-88f5-91d67a5e59f6.png" width="153" height="30" alt="Chromatic" /></a>
|
||
|
||
Thanks to [Chromatic](https://www.chromatic.com/) for providing the visual testing platform that helps us review UI changes and catch visual regressions.
|
||
|
||
## License
|
||
|
||
See [LICENSE] for details.
|
||
|
||
[](https://app.fossa.com/projects/git%2Bgithub.com%2Ftoeverything%2FAFFiNE?ref=badge_large)
|
||
|
||
[all-contributors-badge]: https://img.shields.io/github/contributors/toeverything/AFFiNE
|
||
[license]: ./LICENSE
|
||
[building.md]: ./docs/BUILDING.md
|
||
[update page]: https://affine.pro/blog?tag=Release%20Note
|
||
[jobs available]: ./docs/jobs.md
|
||
[latest packages]: https://github.com/toeverything/AFFiNE/pkgs/container/affine-self-hosted
|
||
[contributor license agreement]: https://github.com/toeverything/affine/edit/canary/.github/CLA.md
|
||
[rust-version-icon]: https://img.shields.io/badge/Rust-1.74.0-dea584
|
||
[stars-icon]: https://img.shields.io/github/stars/toeverything/AFFiNE.svg?style=flat&logo=github&colorB=red&label=stars
|
||
[codecov]: https://codecov.io/gh/toeverything/affine/branch/canary/graphs/badge.svg?branch=canary
|
||
[node-version-icon]: https://img.shields.io/badge/node-%3E=18.16.1-success
|
||
[typescript-version-icon]: https://img.shields.io/github/package-json/dependency-version/toeverything/affine/dev/typescript
|
||
[react-version-icon]: https://img.shields.io/github/package-json/dependency-version/toeverything/AFFiNE/react?filename=packages%2Ffrontend%2Fcore%2Fpackage.json&color=rgb(97%2C228%2C251)
|
||
[blocksuite-icon]: https://img.shields.io/github/package-json/dependency-version/toeverything/AFFiNE/@blocksuite/store?color=6880ff&filename=packages%2Ffrontend%2Fcore%2Fpackage.json&label=blocksuite
|