toeverything/AFFiNE
1
1
Fork 0
mirror of https://github.com/toeverything/AFFiNE.git synced 2024-12-22 10:21:37 +03:00
Code Issues Packages Projects Releases Wiki Activity
There can be more than Notion and Miro. AFFiNE is a next-gen knowledge base that brings planning, sorting and creating all together. Privacy first, open-source, customizable and ready to use.
157 Commits 66 Branches 453 Tags 350 MiB
TypeScript 97.4%
JavaScript 1.3%
Rust 0.9%
CSS 0.3%
4772ed170b
Go to file
CJSS 4772ed170b
Update README.md
2022-10-26 09:35:30 +08:00
.github chore: update workflow 2022-10-25 22:30:11 +08:00
.vscode chore: change to monorepo 2022-10-14 13:26:06 +08:00
packages chore: update workflow 2022-10-25 22:30:11 +08:00
scripts/module-resolve feat: module resolve 2022-10-19 17:53:10 +08:00
.eslintignore feat: init basic settings 2022-09-22 15:39:53 +08:00
.eslintrc.js chore: change to monorepo 2022-10-14 13:26:06 +08:00
.gitignore feat: module resolve 2022-10-19 17:53:10 +08:00
.pnpmfile.cjs feat: module resolve 2022-10-19 17:53:10 +08:00
.prettierrc feat: init basic settings 2022-09-22 15:39:53 +08:00
package.json chore: update dev command 2022-10-19 23:05:42 +08:00
pnpm-lock.yaml feat: update blocksuite version 2022-10-24 18:22:36 +08:00
pnpm-workspace.yaml chore: change to monorepo 2022-10-14 13:26:06 +08:00
README.md Update README.md 2022-10-26 09:35:30 +08:00

README.md

AFFiNE.PRO
The Next-Gen Collaborative Knowledge Base

AFFiNE is a next-gen knowledge base that brings planning, sorting and creating all together.
Privacy first, open-source, customizable and ready to use - a free replacement for Notion & Miro.

Node React React Rust

       


affine_screen

Get Involved

Before we tell you how to get started with AFFiNE, we'd like to shamelessly plug our awesome user and developer communities! Once you’re familiar with using the software, maybe you will share your wisdom with others and join the AFFiNE Ambassador program.

Contributing

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.

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

For translation and language support you can visit our docs for the internationalization guide

If you have questions, join our social platforms where our friendly community can help provide the answers.

Getting Started

⚠️ Please note that AFFiNE is still under active development and is not yet ready for production use. ⚠️

affine.pro No installation or registration required! Head over to our website and try it out now.

AFFiNE Documentation - More detailed documentation on how to use and develop with AFFiNE

Our social platforms - Join our friendly communities for more support and discussions

Thanks

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

  • Yjs & Yrs -- Fundamental support of CRDTs for our implementation on state management and data sync.
  • React -- View layer support and web GUI framework.
  • Rust -- High performance language that extends the ability and availability of our real-time backend, JWST.
  • Fossil -- Source code management tool made with CRDTs which inspired our design on block data structure.
  • slatejs -- Customizable rich-text editor.
  • Jotai -- Minimal state management tool for frontend.
  • Tldraw -- Excellent drawing board.
  • MUI -- Our most used graphic UI component library.
  • Other dependencies

We use the following open source projects to help us build a better development experience:

  • nx -- Awesome monorepo manager & build system
  • tolgee -- Elegant i18n collaborative editing platform

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.

Jobs

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.

License

See LICENSE for details.