toeverything/AFFiNE
1
1
Fork 0
mirror of https://github.com/toeverything/AFFiNE.git synced 2024-12-28 10:26:18 +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.
134 Commits 66 Branches 453 Tags 350 MiB
TypeScript 97.4%
JavaScript 1.3%
Rust 0.9%
CSS 0.3%
c03749d216
Go to file
DarkSky c03749d216
Merge pull request #28 from toeverything/bugfix/leftlayout220802 
Bugfix/leftlayout220802
2022-08-02 11:45:12 +08:00
.github Update config.yml 2022-08-02 10:51:40 +08:00
.husky init: the first public commit for AFFiNE 2022-07-22 15:49:21 +08:00
.vscode init: the first public commit for AFFiNE 2022-07-22 15:49:21 +08:00
apps fixbug There is a bug in the rename workspace name function in doc mode #15 2022-08-02 11:17:59 +08:00
docs refactor(src): change affine to AFFiNE in string 2022-08-01 14:27:26 +08:00
libs fixbug When opening multiple left sidebar "three-dot" menus in doc mode, the menu boxes will block each other. #16 2022-08-02 11:22:02 +08:00
tools init: the first public commit for AFFiNE 2022-07-22 15:49:21 +08:00
.all-contributorsrc init: the first public commit for AFFiNE 2022-07-22 15:49:21 +08:00
.cz-config.js init: the first public commit for AFFiNE 2022-07-22 15:49:21 +08:00
.editorconfig init: the first public commit for AFFiNE 2022-07-22 15:49:21 +08:00
.env init: the first public commit for AFFiNE 2022-07-22 15:49:21 +08:00
.env.local-dev feat: router & block preview 2022-07-24 21:56:03 +08:00
.eslintignore init: the first public commit for AFFiNE 2022-07-22 15:49:21 +08:00
.eslintrc.json feat(comming-soon): add comming-soon 2022-07-22 21:38:57 +08:00
.gitignore init: the first public commit for AFFiNE 2022-07-22 15:49:21 +08:00
.npmrc init: the first public commit for AFFiNE 2022-07-22 15:49:21 +08:00
.prettierignore style(formatting): update .prettierignore 2022-08-01 10:59:38 +08:00
.prettierrc init: the first public commit for AFFiNE 2022-07-22 15:49:21 +08:00
babel.config.json init: the first public commit for AFFiNE 2022-07-22 15:49:21 +08:00
Caddyfile init: the first public commit for AFFiNE 2022-07-22 15:49:21 +08:00
Dockerfile init: the first public commit for AFFiNE 2022-07-22 15:49:21 +08:00
Dockerfile-keck fix: rebase glitch 2022-08-01 02:15:25 +08:00
jest.config.js init: the first public commit for AFFiNE 2022-07-22 15:49:21 +08:00
jest.preset.js init: the first public commit for AFFiNE 2022-07-22 15:49:21 +08:00
LICENSE init: the first public commit for AFFiNE 2022-07-22 15:49:21 +08:00
nx.json init: the first public commit for AFFiNE 2022-07-22 15:49:21 +08:00
package.json feat: router & block preview 2022-07-24 21:56:03 +08:00
pnpm-lock.yaml feat: router & block preview 2022-07-24 21:56:03 +08:00
pnpm-workspace.yaml init: the first public commit for AFFiNE 2022-07-22 15:49:21 +08:00
README.md docs(readme): remove unused description 2022-08-01 16:04:05 +08:00
tsconfig.base.json init: the first public commit for AFFiNE 2022-07-22 15:49:21 +08:00
workspace.json feat: merge keck 2022-07-22 17:04:52 +08:00

README.md

AFFiNE

All Contributors

Workspace for AFFiNE

Installation

# Clone the repo
git clone git@github.com:toeverything/AFFiNE.git

Once cloned, switch to the master branch and navigate to the folder by typing cd AFFiNE and then running the following commands:

# Install all project dependencies
npm i -g pnpm
pnpm i

# Start the project
pnpm start
open http://localhost:4200/

This project uses pnpm for package management and is built based on nx. It is recommended to install the nx console plugin to create dependencies

If it is development, you can add environment variables in the project directory .env.local file

NODE_ENV=development

Scripts

  1. Create react dependency library: pnpm run add:library
  2. Create react components: pnpm run add:components
  3. Create a data source: pnpm run add:datasource
  4. Unit testing: pnpm test
  5. Compile specific components
    • pnpm build/test/lint project name
    • Project name reference workspace.json
  6. Create react/node program: use nx console
  7. If you need to use the git cz function, please install it globally first commitizen npm install -g commitizen conventional-changelog conventional-changelog-cli

Contributing

  • Generic functional components (such as ui components) are placed in libs/components/common
    • components within common are not allowed to reference components except utils and dependencies
    • Common components can reference each other
  • Business components are placed in libs/components
  • The data source component is placed in libs/datasource - api request code, schema, etc. belong to the data source Please see CONTRIBUTING

Documentation

Community

For help, discussion about best practices, or any other conversation that would benefit from being searchable:

Discuss AFFiNE on GitHub

Contributors


DarkSky
💻 📖
Chi Zhang
💻 📖
alt1o
💻 📖
Diamond
💻 📖
Whitewater
💻 📖
zuoxiaodong0815
💻 📖
SaikaSakura
💻 📖

Qi
💻 📖
tuluffy
💻 📖
Austaras
💻 📖
Jin Yao
💻 📖

License

AFFiNE is distributed under the terms of MIT license.

See LICENSE for details.